Atualizar mailSearchFolder
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Atualize as propriedades graváveis de um objeto mailSearchFolder .
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA 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. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas 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 de exibição do mailFolder. |
includeNestedFolders | Booliano | Como a hierarquia de pastas de caixa de correio deve ser atravessada. true significa que uma pesquisa profunda deve ser feita enquanto false significa que uma pesquisa superficial deve ser feita em vez disso. |
sourceFolderIds | Coleção de cadeias de caracteres | As pastas de caixa de correio que devem ser extraídas. |
filterQuery | Cadeia de caracteres | A consulta OData para filtrar as mensagens. |
Resposta
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e um objeto mailFolder atualizado no corpo da resposta.
Exemplo
Solicitação
A seguir está uma solicitação de exemplo que atualiza a propriedade filterQuery da pasta de pesquisa.
PATCH https://graph.microsoft.com/beta/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,
"wellKnownName": null,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzMi"
],
"filterQuery": "contains(subject, 'Analytics')"
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de