Criar mailSearchFolder

Namespace: microsoft.graph

Crie uma nova mailSearchFolder na caixa de correio do usuário especificada.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Mail.ReadWrite Indisponível.
Delegado (conta pessoal da Microsoft) Mail.ReadWrite Indisponível.
Aplicativo Mail.ReadWrite Indisponível.

Solicitação HTTP

POST /me/mailFolders/{id}/childFolders
POST /users/{id | userPrincipalName}/mailFolders/{id}/childFolders

Especifique a pasta pai na URL de consulta como uma ID de pasta ou um nome de pasta conhecido. Confira uma lista de nomes de pasta comuns com suporte em Tipo de recurso mailFolder.

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização Bearer {token}. Obrigatório.
Content-Type application/json. Obrigatório.

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
@odata.type Cadeia de caracteres O tipo de pasta a ser criada. Definido como "microsoft.graph.mailSearchFolder".
displayName String O nome de exibição da nova pasta.
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.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto mailSearchFolder no corpo da resposta.

Exemplo

Solicitação

Veja a seguir um exemplo da solicitação: ela cria uma pasta de pesquisa de mensagens que contém a cadeia de caracteres "resumo semanal" no assunto. A pasta de pesquisa está na mesma pasta à qual a consulta de filtro especificada se aplica.

POST https://graph.microsoft.com/v1.0/me/mailFolders/AQMkADYAAAIBDAAAAA==/childFolders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.mailSearchFolder",
  "displayName": "Weekly digests",
  "includeNestedFolders": true,
  "sourceFolderIds": ["AQMkADYAAAIBDAAAAA=="],
  "filterQuery": "contains(subject, 'weekly digest')"
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders('AQMkADYAAAIBDAAAAA%3D%3D')/childFolders/$entity",
    "@odata.type": "#microsoft.graph.mailSearchFolder",
    "id": "AAMkADYfRAAAZg1yTAAA=",
    "displayName": "Weekly digests",
    "parentFolderId": "AQMkADYAAAIBDAAAAA==",
    "childFolderCount": 0,
    "unreadItemCount": 0,
    "totalItemCount": 0,
    "isSupported": true,
    "includeNestedFolders": true,
    "sourceFolderIds": [
        "AQMkADYAAAIBDAAAAA=="
    ],
    "filterQuery": "contains(subject, 'weekly digest')"
}