Tipo de recurso mailSearchFolder

Namespace: microsoft.graph

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

Ciclo de vida da pasta de pesquisa

As pastas de pesquisa criadas pelo aplicativo podem ser excluídas por Exchange Online por um dos seguintes motivos:

  1. As pastas de pesquisa expiram após 45 dias sem uso.
  2. Há limites no número de pastas de pesquisa que podem ser criadas por pasta de origem. Quando esse limite é violado, 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 usar o mesmo.

Métodos

Método Tipo de retorno Descrição
Criar uma pasta de pesquisa mailSearchFolder Crie uma pasta de pesquisa na caixa de correio desse usuário.
Listar pastas de pesquisa Coleção mailFolder Listar todas as pastas na caixa de correio desse usuário, incluindo pastas de pesquisa.
Obter uma pasta de pesquisa mailSearchFolder Obter a pasta de pesquisa especificada.
Atualizar uma pasta de pesquisa mailSearchFolder Atualize a pasta de pesquisa especificada.
Excluir uma pasta de pesquisa None Exclua a pasta de pesquisa especificada.
Listar todas as mensagens em uma pasta de pesquisa Coleção message Lista 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 Boolean Indica como a hierarquia de pastas de caixa de correio deve ser percorrido 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 Coleção String As pastas de caixa de correio que devem ser mineradas.
filterQuery Cadeia de caracteres A consulta OData para filtrar as mensagens.

Representação JSON

Veja a seguir uma representação JSON do recurso.

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