获取 mailFolderGet mailFolder

命名空间:microsoft.graphNamespace: microsoft.graph

检索邮件文件夹对象的属性和关系。Retrieve the properties and relationships of a message folder object.

在下列两种情况下,应用可获取其他用户的邮件文件夹:There are two scenarios where an app can get another user's mail folder:

  • 如果该应用具有应用程序权限,或者If the app has application permissions, or,
  • 如果应用具有来自某个用户的相应委派权限,而另一个用户与该用户共享了邮件文件夹,或者已为该用户授予委派的访问权限。If the app has the appropriate delegated permissions from one user, and another user has shared a mail folder with that user, or, has given delegated access to that user. 请参阅详细信息和示例See details and an example.

权限Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

权限类型Permission type 权限(从最低特权到最高特权)Permissions (from least to most privileged)
委派(工作或学校帐户)Delegated (work or school account) Mail.ReadBasic、Mail.Read、Mail.ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
委派(个人 Microsoft 帐户)Delegated (personal Microsoft account) Mail.ReadBasic、Mail.Read、Mail.ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
应用程序Application Mail.ReadBasic.All、Mail.Read、Mail.ReadWriteMail.ReadBasic.All, Mail.Read, Mail.ReadWrite

HTTP 请求HTTP request

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

可选的查询参数Optional query parameters

此方法支持 OData 查询参数 来帮助自定义响应。This method supports the OData Query Parameters to help customize the response.

请求标头Request headers

名称Name 类型Type 说明Description
AuthorizationAuthorization stringstring Bearer {token}。必需。Bearer {token}. Required.

请求正文Request body

请勿提供此方法的请求正文。Do not supply a request body for this method.

响应Response

如果成功,此方法在响应正文中返回 200 OK 响应代码和 MailFolder 对象。If successful, this method returns a 200 OK response code and mailFolder object in the response body.

示例Examples

示例 1:获取邮件文件夹Example 1: Get a mail folder

请求Request

下面展示了示例请求。The following is an example of the request.

GET https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzM

响应Response

下面是一个响应示例。The following is an example of the response.

注意: 为了提高可读性,可能缩短了此处显示的响应对象。Note: The response object shown here might be shortened for readability. 所有属性都将通过实际调用返回。All the properties will be returned from an actual call.

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

{
  "id": "AAMkAGVmMDEzM",
  "displayName": "Inbox",
  "parentFolderId": "AAMkAGVmMDEzI",
  "childFolderCount": 2,
  "unreadItemCount": 59,
  "totalItemCount": 60
}

示例 2:获取邮件搜索文件夹Example 2: Get a mail search folder

请求Request

下面展示了示例请求。The following is an example of the request.

GET https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzN

响应Response

下面是一个响应示例。The following is an example of the response.

注意: 为了提高可读性,可能缩短了此处显示的响应对象。Note: The response object shown here might be shortened for readability. 所有属性都将通过实际调用返回。All the properties will be returned from an actual call.

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,
  "isSupported": true,
  "includeNestedFolders": true,
  "sourceFolderIds": [
    "AAMkAGVmMDEzM"
  ],
  "filterQuery": "contains(subject, 'MyAnalytics')"
}