Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa uma pasta na caixa de correio de um usuário, como Caixa de entrada, Rascunhos ou outras pastas criadas pelo usuário. As pastas podem conter vários itens de caixa de correio, como mensagens, eventos, contatos, outros itens do Outlook e pastas filho.
Esse recurso dá suporte à consulta delta para acompanhar adições, exclusões e atualizações incrementais, fornecendo uma função delta . Ele também dá suporte a propriedades estendidas de valor único e vários valores para armazenar e acessar dados personalizados que ainda não estão expostos nos metadados da API do Graph Microsoft.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | coleção mailboxFolder | Obtenha todos os objetos mailboxFolder na caixa de correio especificada, incluindo as pastas de pesquisa. |
| Create | pasta de caixa de correio | Criar uma nova caixa de correioPasta ou caixa de correio filhoPasta na caixa de correio de um usuário. |
| Get | pasta de caixa de correio | Leia as propriedades e relações de um objeto mailboxFolder . |
| Atualizar | pasta de caixa de correio | Atualizar propriedades mailboxFolder como displayName dentro de uma caixa de correio. |
| Delete | Nenhum | Excluir uma caixa de correioPasta ou uma caixa de correio secundáriaPasta dentro de uma caixa de correio. |
| Obter delta | coleção mailboxFolder | Obtenha um conjunto de objetos mailboxFolder que foram adicionados, excluídos ou removidos da caixa de correio do usuário. |
| Listar pastas de caixa de correio filho | coleção mailboxFolder | Obtenha a coleção mailboxFolder na mailboxFolder especificada em uma caixa de correio. |
| Listar itens na pasta | coleção mailboxItem | Obtenha a coleção mailboxItem em uma pasta de caixa de correio especificada em uma caixa de correio. |
| Excluir item da pasta | Nenhum | Excluir um mailboxItem de uma pasta mailbox em uma caixa de correio. |
| Propriedades estendidas | ||
| Criar uma propriedade de valor único | pasta de caixa de correio | Criar uma ou mais propriedades estendidas de valor único em uma pasta de caixa de correio nova ou existente. |
| Obter uma propriedade de valor único | pasta de caixa de correio | Obter pastas de caixa de correio que contêm uma propriedade estendida de valor único usando $expand ou $filter. |
| Criar propriedade de vários valores | pasta de caixa de correio | Criar uma ou mais propriedades estendidas de vários valores em uma pasta de caixa de correio nova ou existente. |
| Obter propriedade de vários valores | pasta de caixa de correio | Obter uma pasta de caixa de correio que contém uma propriedade estendida de vários valores usando .$expand |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| childFolderCount | Int32 | O número de pastas filho imediato na pasta atual. |
| displayName | Cadeia de caracteres | O nome de exibição da pasta. |
| id | Cadeia de caracteres | O identificador exclusivo da pasta. |
| IsHidden | Booleano | Indica se a pasta está oculta. O valor padrão é false. Esta propriedade pode ser definida somente quando você cria a pasta; ele não pode ser atualizado usando PATCH. Por padrão, listar pastas ou listar pastas filho retorna apenas pastas que não estão ocultas. Para incluir pastas ocultas na resposta, use o parâmetro includeHiddenFolders=truede consulta opcional . A resposta inclui pastas ocultas e não ocultas. Se você usa $select para limitar as propriedades retornadas, inclua isHidden na seleção. |
| parentFolderId | Cadeia de caracteres | O identificador exclusivo da pasta pai dessa pasta. |
| parentMailboxUrl | Cadeia de caracteres | O link de roteamento para a caixa de correio subjacente real onde a pasta reside fisicamente. A pasta pode ser acessada usando GET {parentMailboxUrl}/folders/{id}, que trata toda a URL como uma cadeia de caracteres opaca. Esse método é especialmente importante quando o arquivamento de expansão automática está habilitado para a caixa de correio de arquivo morto in-loco de um usuário. O conteúdo do arquivo morto do usuário pode se estender por várias caixas de correio nesses cenários. |
| totalItemCount | Int32 | O número de itens na pasta. |
| type | Cadeia de caracteres | Descreve o tipo de classe de pasta. |
| wellKnownName | Cadeia de caracteres | O nome conhecido independente da localidade da pasta para pastas criadas pelo Outlook, como inbox, sentitems, drafts, deleteditems, ou archive. Para pastas criadas pelo usuário, o valor é null. Somente leitura. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| childFolders | coleção mailboxFolder | A coleção de pastas filho nesta pasta. |
| items | coleção mailboxItem | A coleção de itens nesta pasta. |
| multiValueExtendedProperties | Coleção multiValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para o mailboxFolder. |
| singleValueExtendedProperties | Coleção singleValueLegacyExtendedProperty | A coleção de propriedades estendidas de valor único definidas para o mailboxFolder. |
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"displayName": "String",
"childFolderCount": "Int32",
"id": "String (identifier)",
"isHidden": "Boolean",
"parentFolderId": "String",
"parentMailboxUrl": "String",
"totalItemCount": "Int32",
"wellKnownName": "String",
"type": "String"
}