user: getMailTips

名前空間: microsoft.graph

サインイン しているユーザーが利用できる 1 人以上の受信者のメール ヒントを取得します。

アクションを POST 呼び出すことで、一度に getMailTips 複数の受信者に対して特定の種類のメール ヒントを返すように要求できます。 要求されたメール ヒントは、 メール ヒント コレクションに返されます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) Mail.Read Mail.Read.Shared
委任 (個人用 Microsoft アカウント) Mail.Read 注意事項なし。
アプリケーション Mail.Read 注意事項なし。

HTTP 要求

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

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

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。

要求ヘッダー

ヘッダー
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

プロパティ 説明
EmailAddresses String collection メール ヒントを取得する受信者の SMTP アドレスのコレクションです。
MailTipsOptions 文字列 要求されたメール ヒントを表すフラグの列挙。 使用可能な値は、、、、、、moderationStatusexternalMemberCountrecipientSuggestionsrecipientScopemaxMessageSizemailboxFullStatusおよび totalMemberCountです。 deliveryRestrictioncustomMailTipautomaticReplies

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文の メール ヒント オブジェクトのコレクションを返します。

要求

次の例では、指定した受信者のメール ヒントを取得し、自動応答設定とメールボックスの完全な状態を取得します。

POST https://graph.microsoft.com/v1.0/me/getMailTips
Content-Type: application/json

{
    "EmailAddresses": [
        "danas@contoso.com",
        "fannyd@contoso.com"
    ],
    "MailTipsOptions": "automaticReplies, mailboxFullStatus"
}
応答

次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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
        }
    ]
}