命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
代表已登录用户提交电子邮件请求,以取消订阅电子邮件通讯组列表。 使用 标头中 List-Unsubscribe
的信息。
邮件发件人可以通过包括收件人选择退出的选项,以用户友好的方式使用邮件列表。可以通过在 RFC-2369 后面的每条消息中指定List-Unsubscribe
标头来执行此操作。
注意 具体而言,若要使 取消订阅 操作正常工作,发件人必须指定 mailto:
而不是基于 URL 的取消订阅信息。
设置该标头还会将消息实例的 unsubscribeEnabled 属性设置为 true
,并将 unsubscribeData 属性设置为标头数据。
如果消息的 unsubscribeEnabled 属性为 true
,则可以使用 取消订阅 操作来取消订阅用户与邮件发件人管理的类似将来的邮件。
成功的 取消订阅 操作会将邮件移动到“ 已删除邮件” 文件夹。 从将来的邮件分发中实际排除用户由发件人管理。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
Mail.Send |
不可用。 |
委派(个人 Microsoft 帐户) |
Mail.Send |
不可用。 |
应用程序 |
Mail.Send |
不可用。 |
HTTP 请求
POST /users/{id | userPrincipalName}/messages/{id}/unsubscribe
名称 |
类型 |
说明 |
Authorization |
string |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法返回 202 Accepted
响应代码。 它不会在响应正文中返回任何内容。
示例
下面是如何调用此 API 的示例。
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/me/messages/{id}/unsubscribe
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Messages["{message-id}"].Unsubscribe.PostAsync();
mgc-beta users messages unsubscribe post --user-id {user-id} --message-id {message-id}
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Messages().ByMessageId("message-id").Unsubscribe().Post(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.me().messages().byMessageId("{message-id}").unsubscribe().post();
const options = {
authProvider,
};
const client = Client.init(options);
await client.api('/me/messages/{id}/unsubscribe')
.version('beta')
.post();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$graphServiceClient->me()->messages()->byMessageId('message-id')->unsubscribe()->post()->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Invoke-MgBetaUnsubscribeUserMessage -UserId $userId -MessageId $messageId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
await graph_client.me.messages.by_message_id('message-id').unsubscribe.post()
响应
以下示例显示了相应的响应。
HTTP/1.1 202 Accepted