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 respetivo nome.

Métodos

Propriedades

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://outlook.office.com/api/beta/me/folders/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

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,
  "wellKnownName": "string",
  "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" }]
}

Conteúdo relacionado

• Usar a consulta delta para controlar alterações nos dados do Microsoft Graph
• Obter as alterações incrementais para as mensagens em uma pasta