名前空間: microsoft.graph
サインイン しているユーザーが利用できる 1 人以上の受信者のメール ヒントを取得します。
getMailTips アクションをPOST呼び出すことで、一度に複数の受信者に対して特定の種類のメール ヒントを返すように要求できます。 要求されたメール ヒントは、 メール ヒント コレクションに返されます。
この 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 |
文字列 |
要求されたメール ヒントを表すフラグの列挙。 使用できる値は、 automaticReplies、 customMailTip、 deliveryRestriction、 externalMemberCount、 mailboxFullStatus、 maxMessageSize、 moderationStatus、 recipientScope、 recipientSuggestions、 totalMemberCountです。 |
応答
成功した場合、このメソッドは 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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Me.GetMailTips;
using Microsoft.Graph.Models;
var requestBody = new GetMailTipsPostRequestBody
{
EmailAddresses = new List<string>
{
"danas@contoso.com",
"fannyd@contoso.com",
},
MailTipsOptions = MailTipsType.AutomaticReplies | MailTipsType.MailboxFullStatus,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.GetMailTips.PostAsGetMailTipsPostResponseAsync(requestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphusers.NewItemGetMailTipsPostRequestBody()
emailAddresses := []string {
"danas@contoso.com",
"fannyd@contoso.com",
}
requestBody.SetEmailAddresses(emailAddresses)
mailTipsOptions := graphmodels.AUTOMATICREPLIES, MAILBOXFULLSTATUS_MAILTIPSTYPE
requestBody.SetMailTipsOptions(&mailTipsOptions)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
getMailTips, err := graphClient.Me().GetMailTips().PostAsGetMailTipsPostResponse(context.Background(), requestBody, nil)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.users.item.getmailtips.GetMailTipsPostRequestBody getMailTipsPostRequestBody = new com.microsoft.graph.users.item.getmailtips.GetMailTipsPostRequestBody();
LinkedList<String> emailAddresses = new LinkedList<String>();
emailAddresses.add("danas@contoso.com");
emailAddresses.add("fannyd@contoso.com");
getMailTipsPostRequestBody.setEmailAddresses(emailAddresses);
getMailTipsPostRequestBody.setMailTipsOptions(EnumSet.of(MailTipsType.AutomaticReplies, MailTipsType.MailboxFullStatus));
var result = graphClient.me().getMailTips().post(getMailTipsPostRequestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const mailTips = {
EmailAddresses: [
'danas@contoso.com',
'fannyd@contoso.com'
],
MailTipsOptions: 'automaticReplies, mailboxFullStatus'
};
await client.api('/me/getMailTips')
.post(mailTips);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\GetMailTips\GetMailTipsPostRequestBody;
use Microsoft\Graph\Generated\Models\MailTipsType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new GetMailTipsPostRequestBody();
$requestBody->setEmailAddresses(['danas@contoso.com', 'fannyd@contoso.com', ]);
$requestBody->setMailTipsOptions(new MailTipsType('automaticReplies, mailboxFullStatus'));
$result = $graphServiceClient->me()->getMailTips()->post($requestBody)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.Users.Actions
$params = @{
EmailAddresses = @(
"danas@contoso.com"
"fannyd@contoso.com"
)
MailTipsOptions = "automaticReplies, mailboxFullStatus"
}
# A UPN can also be used as -UserId.
Get-MgUserMailTip -UserId $userId -BodyParameter $params
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.get_mail_tips.get_mail_tips_post_request_body import GetMailTipsPostRequestBody
from msgraph.generated.models.mail_tips_type import MailTipsType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = GetMailTipsPostRequestBody(
email_addresses = [
"danas@contoso.com",
"fannyd@contoso.com",
],
mail_tips_options = MailTipsType.AutomaticReplies | MailTipsType.MailboxFullStatus,
)
result = await graph_client.me.get_mail_tips.post(request_body)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
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
}
]
}