tipo de recurso mailFolder
Namespace: microsoft.graph
Uma pasta de email na caixa de correio de um usuário, como Caixa de entrada e Rascunhos. As pastas de email podem conter mensagens, outros itens do Outlook e pastas de correio filho.
Esse recurso tem suporte para o uso da consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
Nomes de pasta conhecidos
O Outlook cria determinadas pastas para usuários por padrão. Em vez de usar a pasta correspondente com valor id para sua conveniência, você pode usar os nomes das pastas conhecidas na tabela abaixo ao acessar essas pastas. Por exemplo, você encontra a pasta de Rascunhos usando seu nome reconhecido com a seguinte consulta.
GET /me/mailFolders/drafts
Os nomes conhecidos funcionam independentemente da região da caixa de correio do utilizador, pelo que a consulta acima devolverá sempre a pasta Rascunhos do utilizador, independentemente do nome.
| Nome da pasta conhecida | Descrição |
|---|---|
| arquivar | As mensagens da pasta arquivo morto são enviadas ao usar o recurso arquivar One_Click em clientes do Outlook que são compatíveis com ele. Nota: isto não é o mesmo que a funcionalidade Caixa de Correio de Arquivo do Exchange online. |
| Email secundário | As mensagens de baixa prioridade da pasta de email secundário são movidas ao usar o recurso email secundário. |
| Conflitos | A pasta que contém itens conflitantes na caixa de correio. |
| conversationhistory | A pasta em que o Skype salva conversas de mensagens Instantâneas (se o Skype está configurado para fazer isso). |
| deleteditems | Os itens da pasta são movidos para quando são eliminados. |
| rascunhos | A pasta que contém as mensagens não enviadas. |
| caixa de entrada | A pasta caixa de entrada. |
| junkemail | A pasta lixo eletrônico. |
| localfailures | A pasta que contém itens que existem no cliente local, mas que não foi possível carregar para o servidor. |
| msgfolderroot | A pasta "Superior do repositório de informações". Esta pasta é a pasta pai das pastas que são exibidas em clientes de email normais, como a caixa de entrada. |
| Caixa de saída | A pasta caixa de saída. |
| recoverableitemsdeletions | A pasta que contém itens excluídos de modo reversível: excluído da pasta Itens excluídos ou ao pressionar shift + delete no Outlook. Esta pasta não está visível em nenhum cliente de e-mail do Outlook, mas os utilizadores finais podem interagir com a mesma através da funcionalidade Recuperar Itens Eliminados do Servidor no Outlook ou Outlook na Web. |
| agendado | A pasta que contém mensagens que estão agendadas para serem exibidas na caixa de entrada usando o recurso de cronograma do Outlook para iOS. |
| SearchFolders | A pasta pai para todas as pastas de pesquisa definida na caixa de correio do usuário. |
| sentitems | A pasta Itens enviados. |
| serverfailures | A pasta que contém itens que existem no servidor, mas que não foi possível sincronizar com o cliente local. |
| syncissues | A pasta que contém os logs de sincronização criados pelo Outlook. |
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Listar pastas de pesquisa de email | Coleção mailFolder | Obtenha todas as pastas de email na caixa de correio do usuário especificado, incluindo quaisquer pastas de pesquisa de email. |
| Obter pasta de pesquisa de email | mailFolder | Leia as propriedades e os relacionamentos do objeto mailFolder. |
| Criar pasta de email | mailFolder | Crie uma nova pasta de email na pasta raiz da caixa de correio do usuário. |
| Listar pastas filho | Coleção MailFolder | Obtenha a coleção de pastas sob a pasta especificada. Você pode usar o atalho .../me/MailFolders para obter a coleção de pastas de nível superior e navegar até outra pasta. |
| Criar pasta filho | mailFolder | Criar uma nova mailFolder na atual postando na coleção childFolders. |
| Criar mensagem na pasta | Mensagem | Crie uma nova mensagem na mailFolder atual postando na coleção de mensagens. |
| Listar mensagens na pasta | Coleção Message | Obtenha todas as mensagens na caixa de correio do usuário conectado, ou em uma pasta especificada na caixa de correio. |
| Atualizar pasta de email | mailFolder | Atualize o objeto mailFolder especificado. |
| Excluir pasta de pesquisa de email | Nenhuma | Exclua o objeto mailFolder especificado. |
| Copiar pasta de email | MailFolder | Copie uma mailFolder e seu conteúdo para outra mailFolder. |
| Obter a pasta de email delta | Coleção mailFolder | Obtenha um conjunto de pastas de email que foram adicionadas, excluídas ou removidas da caixa de correio do usuário. |
| Mover pasta de email | MailFolder | Mova uma mailFolder e seu conteúdo para outra mailFolder. |
| Propriedades estendidas | ||
| Criar uma propriedade de valor único | mailFolder | Criar uma ou mais propriedades estendidas de valor único em uma mailFolder nova ou existente. |
| Obter uma propriedade de valor único | mailFolder | Obtenha mailFolders que contêm uma propriedade estendida de valor único usando $expand ou $filter. |
| Create propriedade de múltiplos valores | mailFolder | Criar uma ou mais propriedades estendidas de vários valores em uma mailFolder nova ou existente. |
| Obter propriedade de múltiplos valores | mailFolder | Obtenha uma mailFolder que contém uma propriedade estendida com vários valores usando $expand. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| childFolderCount | Int32 | O número de mailFolders filho imediatas na mailFolder atual. |
| displayName | String | O nome de exibição da mailFolder. |
| id | String | Identificador exclusivo de mailFolder. |
| IsHidden | Booleano | Indica se a mailFolder está oculta. Esta propriedade pode ser definida apenas ao criar a pasta. Encontre mais informações em Pastas de email ocultas. |
| parentFolderId | String | O identificador exclusivo de mailFolder do mailFolder pai. |
| totalItemCount | Int32 | O número de itens na mailFolder. |
| unreadItemCount | Int32 | O número de itens na mailFolder marcados como não lidos. |
Acessar contagens de itens de forma eficiente
As propriedades TotalItemCount e UnreadItemCount de uma pasta permitem convenientemente calcular o número de itens de leitura na pasta.
Eles permitem que você evite consultas semelhante à seguinte, que podem causar latência significativa:
https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messages?$count=true&$filter=isread%20eq%20false
As pastas de correio no Outlook podem conter mais do que um tipo de itens, por exemplo, a Caixa de Entrada pode conter itens de pedido de reunião diferentes dos itens de correio.
TotalItemCount e UnreadItemCount incluem itens em uma pasta de email independentemente seus tipos de item.
Pastas de email ocultas
O valor padrão da propriedade isHidden é false. Você pode definir a isHidden apenas uma vez ao criar a mailFolder . Não pode atualizar a propriedade através de uma operação PATCH. Para alterar a propriedade isHidden de uma pasta, exclua a pasta existente e crie uma nova com o valor desejado.
As pastas de email ocultas oferecem suporte a todas as operações suportadas por uma pasta de email normal.
Por predefinição, a listagem de mailFolders devolve apenas pastas de correio que não estão ocultas. Para incluir pastas de email ocultas na resposta, use o parâmetro de consulta includeHiddenFolders=true. Em seguida, use a propriedade isHidden para identificar se uma pasta de email está oculta.
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| childFolders | Coleção MailFolder | A coleção de pastas filho na mailFolder. |
| messageRules | Coleção messageRule | A coleção de regras que se aplicam à pasta da Caixa de Entrada do usuário. |
| mensagens | Coleção Message | A coleção de mensagens na mailFolder. |
| multiValueExtendedProperties | Coleção multiValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para a mailFolder. Somente leitura. Anulável. |
| singleValueExtendedProperties | Coleção singleValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para a mailFolder. Somente leitura. Anulável. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"childFolderCount": 1024,
"displayName": "string",
"id": "string (identifier)",
"parentFolderId": "string",
"totalItemCount": 1024,
"unreadItemCount": 1024,
"isHidden": false,
"childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
"messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
"messages": [ { "@odata.type": "microsoft.graph.message" } ],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}