ユーザー: getMailTips ヒントuser: getMailTips

名前空間: microsoft.graphNamespace: microsoft.graph

サインインしている ユーザーが使用できる1人以上の受信者のメールヒントを取得します。Get the MailTips of one or more recipients as available to the signed-in user.

POSTアクションを呼び出すことによって getMailTips 、複数の受信者に対して特定の種類のメールヒントが一度に返されるように要求することができることに注意してください。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.

アクセス許可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.Read, Mail.Read.Shared
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Mail.ReadMail.Read
アプリケーションApplication Mail.ReadMail.Read

HTTP 要求HTTP request

POST /me/getMailTips
POST /users/{id|userPrincipalName}/getMailTips

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

プロパティProperty Type 説明Description
EmailAddressesEmailAddresses String コレクションString collection メール ヒントを取得する受信者の SMTP アドレスのコレクションです。A collection of SMTP addresses of recipients to get MailTips for.
MailTipsOptionsMailTipsOptions 文字列String 要求されたメールヒントを表すフラグの列挙。A enumeration of flags that represents the requested mailtips. 可能な値は、、、、、、、、、、 automaticReplies customMailTip deliveryRestriction externalMemberCount mailboxFullStatus maxMessageSize moderationStatus recipientScope recipientSuggestions および totalMemberCount です。Possible values are: automaticReplies, customMailTip, deliveryRestriction, externalMemberCount, mailboxFullStatus, maxMessageSize, moderationStatus, recipientScope, recipientSuggestions, and totalMemberCount.

応答Response

成功した場合、このメソッドは応答 200 OK コードと、応答本文で メールヒント オブジェクトのコレクションを返します。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.onmicrosoft.com", 
        "fannyd@contoso.onmicrosoft.com"
    ],
    "MailTipsOptions": "automaticReplies, mailboxFullStatus"
}
応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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.onmicrosoft.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.onmicrosoft.com"
            },
            "automaticReplies":{
                "message":""
            },
            "mailboxFull":false
        }
    ]
}