获取 mailFolder
本文内容
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
检索邮件文件夹对象的属性和关系。
以下列表显示了应用可以获取其他用户的邮件文件夹的两种现有方案：
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
✅
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型 。 要了解有关这些权限的详细信息，请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派（工作或学校帐户）
Mail.ReadBasic
Mail.ReadWrite、Mail.Read
委派（个人 Microsoft 帐户）
Mail.ReadBasic
Mail.ReadWrite、Mail.Read
Application
Mail.ReadBasic.All
Mail.ReadWrite、Mail.Read
HTTP 请求
GET /me/mailFolders/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}
可选的查询参数
此方法支持 OData 查询参数 来帮助自定义响应。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此方法在 200 OK 响应正文中返回响应代码和 mailFolder 对象。
示例
示例 1：获取邮件文件夹
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].GetAsync();
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users mail-folders get --user-id {user-id} --mail-folder-id {mailFolder-id}
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
mailFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolder result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let mailFolder = await client.api('/me/mailFolders/AAMkAGVmMDEzM')
.version('beta')
.get();
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Get-MgBetaUserMailFolder -UserId $userId -MailFolderId $mailFolderId
from msgraph import GraphServiceClient
graph_client = GraphServiceClient(credentials, scopes)
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').get()
响应
以下示例显示了相应的响应。
注意： 为了提高可读性，可能缩短了此处显示的响应对象。
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
}
示例 2：获取邮件搜索文件夹
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzN
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].GetAsync();
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users mail-folders get --user-id {user-id} --mail-folder-id {mailFolder-id}
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
mailFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolder result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let mailFolder = await client.api('/me/mailFolders/AAMkAGVmMDEzN')
.version('beta')
.get();
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Get-MgBetaUserMailFolder -UserId $userId -MailFolderId $mailFolderId
from msgraph import GraphServiceClient
graph_client = GraphServiceClient(credentials, scopes)
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').get()
响应
以下示例显示了相应的响应。
注意： 为了提高可读性，可能缩短了此处显示的响应对象。
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')"
}