user: getMailTips
Namespace: microsoft.graph
Get the MailTips of one or more recipients as available to the signed-in user.
Note that by making a POST
call to the getMailTips
action, you can request specific types of MailTips to
be returned for more than one recipient at one time. The requested MailTips are returned in a mailTips collection.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Mail.Read | Mail.Read.Shared |
Delegated (personal Microsoft account) | Mail.Read | Not available. |
Application | Mail.Read | Not available. |
HTTP request
POST /me/getMailTips
POST /users/{id|userPrincipalName}/getMailTips
Optional query parameters
This method supports the OData Query Parameters to help customize the response.
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json |
Request body
In the request body, provide a JSON object with the following parameters.
Property | Type | Description |
---|---|---|
EmailAddresses | String collection | A collection of SMTP addresses of recipients to get MailTips for. |
MailTipsOptions | String | A enumeration of flags that represents the requested mailtips. Possible values are: automaticReplies , customMailTip , deliveryRestriction , externalMemberCount , mailboxFullStatus , maxMessageSize , moderationStatus , recipientScope , recipientSuggestions , and totalMemberCount . |
Response
If successful, this method returns a 200 OK
response code and a collection of mailTips objects in the response body.
Example
Request
The following example gets MailTips for the specified recipients, for any automatic reply settings and the mailbox full status.
POST https://graph.microsoft.com/v1.0/me/getMailTips
Content-Type: application/json
{
"EmailAddresses": [
"danas@contoso.com",
"fannyd@contoso.com"
],
"MailTipsOptions": "automaticReplies, mailboxFullStatus"
}
Response
The following example shows the response. Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.mailTips)",
"value":[
{
"emailAddress":{
"name":"",
"address":"danas@contoso.com"
},
"automaticReplies":{
"message":"<style type=\"text/css\" style=\"\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n<div dir=\"ltr\">\r\n<div id=\"x_divtagdefaultwrapper\" style=\"font-size:12pt; color:#000000; background-color:#FFFFFF; font-family:Calibri,Arial,Helvetica,sans-serif\">\r\n<p>Hi, I am on vacation right now. I'll get back to you after I return.<br>\r\n</p>\r\n</div>\r\n</div>",
"messageLanguage":{
"locale":"en-US",
"displayName":"English (United States)"
},
"scheduledStartTime": {
"dateTime": "2018-08-07T02:00:00.0000000",
"timeZone": "UTC"
},
"scheduledEndTime": {
"dateTime": "2018-08-09T02:00:00.0000000",
"timeZone": "UTC"
}
},
"mailboxFull":false
},
{
"emailAddress":{
"name":"",
"address":"fannyd@contoso.com"
},
"automaticReplies":{
"message":""
},
"mailboxFull":false
}
]
}
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기