Obter mailFolder
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.
Recupere as propriedades e os relacionamentos de um objeto da pasta de mensagens.
A lista a seguir mostra os dois cenários existentes em que um aplicativo pode obter a pasta de email de outro usuário:
- Se o aplicativo tiver permissões de aplicativo ou
- Se o aplicativo tiver as permissões delegadas apropriadas de um usuário e outro usuário tiver compartilhado uma pasta de email com esse usuário, ou tiver concedido acesso delegado a esse usuário. Para obter mais detalhes, confira Obter mensagens do Outlook em uma pasta compartilhada ou delegada.
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
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Delegado (conta pessoal da Microsoft) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Aplicativo | Mail.ReadBasic.All | Mail.ReadWrite, Mail.Read |
Solicitação HTTP
GET /me/mailFolders/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}
Parâmetros de consulta opcionais
Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e um objeto mailFolder no corpo da resposta.
Exemplos
Exemplo 1: obter uma pasta de email
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM
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
{
"id": "AAMkAGVmMDEzM",
"displayName": "Inbox",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 2,
"unreadItemCount": 59,
"totalItemCount": 60,
"wellKnownName": "inbox",
"isHidden": false
}
Exemplo 2: obter uma pasta de pesquisa de email
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzN
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": "AAMkAGVmMDEzN",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 0,
"unreadItemCount": 6,
"totalItemCount": 6,
"wellKnownName": null,
"isHidden": false,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzM"
],
"filterQuery": "contains(subject, 'MyAnalytics')"
}