Compartilhar via


tipo de recurso mailSearchFolder

Namespace: microsoft.graph

Uma mailSearchFolder é uma pasta virtual na caixa de correio do utilizador que contém todos os itens de e-mail 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 Exchange Online de um utilizador. No entanto, para que uma pasta de pesquisa seja apresentada no Outlook, Outlook para a Web ou no Outlook Live, a pasta tem de ser criada na pasta WellKnownFolderName.SearchFolders.

Ciclo de vida da pasta de pesquisa

As pastas de pesquisa criadas pela sua aplicação podem ser eliminadas por Exchange Online por um dos seguintes motivos:

  1. As pastas de pesquisa expiram após 45 dias sem utilização.
  2. Existem limites no número de pastas de pesquisa que podem ser criadas por pasta de origem. Quando este limite é violado, as pastas de pesquisa mais antigas são eliminadas para dar lugar a novas pastas.

Quando uma pasta de pesquisa é eliminada, a sua aplicação deve criar um novo recurso de pasta de pesquisa e utilizar o mesmo.

Métodos

Método Tipo de retorno Descrição
Criar pasta de pesquisa de email mailSearchFolder Create uma pasta de pesquisa na caixa de correio deste utilizador.
Listar pastas filho Coleção mailFolder Liste todas as pastas na caixa de correio deste utilizador, incluindo pastas de pesquisa.
Obter pasta de pesquisa de email mailSearchFolder Obtenha 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 Elimine a pasta de pesquisa especificada.
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 da pasta da caixa de correio deve ser percorrida na pesquisa. true significa que deve ser feita uma pesquisa profunda para incluir pastas subordinadas na hierarquia de cada pasta especificada explicitamente em sourceFolderIds. false significa uma pesquisa superficial de apenas cada uma das pastas especificadas explicitamente em sourceFolderIds.
isSupported Booliano Indica se uma pasta de pesquisa é editável através de APIs REST.
sourceFolderIds Coleção de cadeias de caracteres As pastas da caixa de correio que devem ser extraídas.

Representação JSON

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

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