user: getMailTips
本文内容
命名空间:microsoft.graph
获取登录用户可用的一个或多个收件人的邮件 提示 。
请注意,通过调用POST``getMailTips操作,可以请求同时为多个收件人返回特定类型的邮件提示。 请求的邮件提示在邮件 提示 集合中返回。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限 。
权限类型
权限(从最低特权到最高特权)
委派(工作或学校帐户)
Mail.Read、Mail.Read.Shared
委派(个人 Microsoft 帐户)
Mail.Read
应用程序
Mail.Read
HTTP 请求
POST /me/getMailTips
POST /users/{id|userPrincipalName}/getMailTips
可选的查询参数
此方法支持 OData 查询参数 来帮助自定义响应。
标头
值
Authorization
Bearer {token}。必需。
Content-Type
application/json
请求正文
在请求正文中,提供具有以下参数的 JSON 对象。
属性
类型
说明
EmailAddresses
String 集合
要获取邮件提示的收件人的 SMTP 地址的集合。
MailTipsOptions
String
表示请求的邮件提示的标志的枚举。 可能的值是:、automaticReplies、deliveryRestriction``customMailTip、、externalMemberCount、mailboxFullStatus、maxMessageSize、recipientScope``moderationStatus``recipientSuggestions、和 totalMemberCount。
响应
如果成功,此方法在响应 200 OK 正文中返回 响应代码和 mailTips 对象集合。
示例
请求
下面的示例获取任何自动答复设置和邮箱已满状态的指定收件人的邮件提示。
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"
}
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var emailAddresses = new List<String>()
{
"danas@contoso.onmicrosoft.com",
"fannyd@contoso.onmicrosoft.com"
};
var mailTipsOptions = MailTipsType.AutomaticReplies | MailTipsType.MailboxFullStatus;
await graphClient.Me
.GetMailTips(emailAddresses,mailTipsOptions)
.Request()
.PostAsync();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
const mailTips = {
EmailAddresses: [
'danas@contoso.onmicrosoft.com',
'fannyd@contoso.onmicrosoft.com'
],
MailTipsOptions: 'automaticReplies, mailboxFullStatus'
};
await client.api('/me/getMailTips')
.post(mailTips);
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/getMailTips"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];
NSMutableArray *emailAddressesList = [[NSMutableArray alloc] init];
[emailAddressesList addObject: @"danas@contoso.onmicrosoft.com"];
[emailAddressesList addObject: @"fannyd@contoso.onmicrosoft.com"];
payloadDictionary[@"EmailAddresses"] = emailAddressesList;
MSGraphMailTipsType *mailTipsOptions = [MSGraphMailTipsType automaticReplies];
payloadDictionary[@"MailTipsOptions"] = mailTipsOptions;
NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
//Request Completed
}];
[meDataTask execute];
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
LinkedList<String> emailAddressesList = new LinkedList<String>();
emailAddressesList.add("danas@contoso.onmicrosoft.com");
emailAddressesList.add("fannyd@contoso.onmicrosoft.com");
EnumSet<MailTipsType> mailTipsOptions = EnumSet.of(MailTipsType.AUTOMATIC_REPLIES,MailTipsType.MAILBOX_FULL_STATUS);
graphClient.me()
.getMailTips(UserGetMailTipsParameterSet
.newBuilder()
.withEmailAddresses(emailAddressesList)
.withMailTipsOptions(mailTipsOptions)
.build())
.buildRequest()
.post();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestBody := msgraphsdk.New()
requestBody.SetEmailAddresses( []String {
"danas@contoso.onmicrosoft.com",
"fannyd@contoso.onmicrosoft.com",
}
mailTipsOptions := "automaticReplies, mailboxFullStatus"
requestBody.SetMailTipsOptions(&mailTipsOptions)
result, err := graphClient.Me().GetMailTips().Post(requestBody)
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Users.Actions
$params = @{
EmailAddresses = @(
"danas@contoso.onmicrosoft.com"
"fannyd@contoso.onmicrosoft.com"
)
MailTipsOptions = "automaticReplies, mailboxFullStatus"
}
# A UPN can also be used as -UserId.
Get-MgUserMailTip -UserId $userId -BodyParameter $params
有关如何将 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.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
}
]
}