tipo de recurso mailSearchFolder

Namespace: microsoft.graph

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 em clientes do Outlook, o local necessário difere de acordo com o cliente:

  • No Outlook para Windows, a pasta deve ser criada em WellKnownFolderName.SearchFolders.
  • No Outlook na Web e no Novo Outlook para Windows, a pasta deve ser criada em SearchFoldersView.

Ciclo de vida da pasta de pesquisa

As pastas de pesquisa criadas pelo seu aplicativo podem ser excluídas pelo Exchange Online 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 pasta de pesquisa de email mailSearchFolder Crie uma pasta de pesquisa na caixa de correio deste usuário.
Listar pastas filho Coleção mailFolder Liste todas as pastas na caixa de correio deste usuário, incluindo as pastas de pesquisa.
Obter pasta de pesquisa de email mailSearchFolder Obter a pasta de pesquisa especificada.
Atualizar pasta de pesquisa de email mailSearchFolder Atualize a pasta de pesquisa especificada.
Excluir pasta de pesquisa de email 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 mensagens na pasta Coleção message Liste todas as mensagens na pasta de pesquisa especificada.

Propriedades

Propriedade Tipo Descrição
filterQuery Cadeia de caracteres A consulta OData para filtrar as mensagens.
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.
isSupported Booliano Indica se uma pasta de pesquisa é editável usando APIs REST.
sourceFolderIds String collection As pastas da caixa de correio que devem ser mineradas.

Representação JSON

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

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