tipo de recurso mailSearchFolder

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.

Uma mailSearchFolder é uma pasta virtual na caixa de correio do usuário que contém todos os itens de email que correspondem aos critérios de pesquisa especificados. mailSearchFolder herda de mailFolder. As pastas de pesquisa podem ser criadas em qualquer pasta na caixa de correio do Exchange Online de um usuário. No entanto, para que uma pasta de pesquisa apareça no Outlook, no Outlook para a Web ou no Outlook Live, ela deve ser criada na pasta WellKnownFolderName.SearchFolders.

Ciclo de vida da pasta de pesquisa

O Exchange Online pode excluir pastas de pesquisa criadas pelo seu aplicativo por um dos seguintes motivos:

  1. As pastas de pesquisa expiram após 45 dias sem uso.
  2. Há limites para o número de pastas de pesquisa que podem ser criadas por pasta de origem. Quando esse limite é violado, as pastas de pesquisa mais antigas são excluídas para dar lugar a novas.

Quando uma pasta de pesquisa é excluída, seu aplicativo deve criar um novo recurso de pasta de pesquisa e usá-lo.

Métodos

Método Tipo de retorno Descrição
Criar mailSearchFolder Crie uma pasta de pesquisa na caixa de correio deste usuário.
Get mailSearchFolder Obter a pasta de pesquisa especificada.
Atualizar mailSearchFolder Atualize a pasta de pesquisa especificada.
Delete Nenhum Exclua a pasta de pesquisa especificada.
Excluir permanentemente Nenhum Excluir permanentemente uma pasta de pesquisa de email e remover seus itens da caixa de correio do usuário.
Listar pastas filho Coleção mailFolder Liste todas as pastas na caixa de correio deste usuário, incluindo as pastas de pesquisa.
Listar mensagens na pasta Coleção message Liste todas as mensagens na pasta de pesquisa especificada.

Propriedades

Propriedade Tipo Descrição
isSupported Booliano Indica se uma pasta de pesquisa é editável usando APIs REST.
includeNestedFolders Booliano Indica como a hierarquia de pastas da caixa de correio deve ser percorrida na pesquisa. true significa que uma pesquisa profunda deve ser feita para incluir pastas filho na hierarquia de cada pasta explicitamente especificada em sourceFolderIds. false significa uma pesquisa superficial de apenas cada uma das pastas explicitamente especificadas em sourceFolderIds.
sourceFolderIds String collection As pastas da caixa de correio que devem ser mineradas.
filterQuery Cadeia de caracteres A consulta OData para filtrar as mensagens.

Relações

Nenhum

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "isSupported": true,
  "includeNestedFolders": true,
  "sourceFolderIds": ["string"],
  "filterQuery": "string"
}