Atualizar mailSearchFolder

Namespace: microsoft.graph

Atualize as propriedades graváveis de um objeto mailSearchFolder .

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

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

Solicitação HTTP

PATCH /me/mailFolders/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/{id}

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
displayName Cadeia de caracteres O nome a apresentar da mailFolder.
includeNestedFolders Booliano Como a hierarquia da pasta da caixa de correio deve ser percorrida. true significa que deve ser feita uma pesquisa profunda enquanto false significa que deve ser feita uma pesquisa superficial.
sourceFolderIds Coleção de cadeias de caracteres As pastas da caixa de correio que devem ser extraídas.
filterQuery Cadeia de caracteres A consulta OData para filtrar as mensagens.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto mailFolder atualizado no corpo da resposta.

Exemplo

Solicitação

Segue-se um pedido de exemplo que atualiza a propriedade filterQuery da pasta de pesquisa.

PATCH https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzM
Content-type: application/json

{
  "@odata.type": "microsoft.graph.mailSearchFolder",
  "filterQuery": "contains(subject, 'Analytics')"
}

Resposta

O exemplo a seguir mostra a resposta.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.mailSearchFolder",
  "id": "AAMkAGVmMDEzMx",
  "displayName": "Get MyAnalytics",
  "parentFolderId": "AAMkAGVmMDEzMy",
  "childFolderCount": 0,
  "unreadItemCount": 0,
  "totalItemCount": 0,
  "isSupported": true,
  "includeNestedFolders": true,
  "sourceFolderIds": [
      "AAMkAGVmMDEzMi"
  ],
  "filterQuery": "contains(subject, 'Analytics')"
}