名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
サインインしているユーザーに代わって電子メール配布リストの登録を解除する電子メール要求を送信します。
List-Unsubscribe ヘッダー内の情報を使用します。
メッセージ送信者は、受信者がオプトアウトするオプションを含めることで、ユーザーフレンドリな方法でメーリング リストを使用できます。これを行うには、RFC-2369 に続く各メッセージで List-Unsubscribe ヘッダーを指定します。
手記 特に、 登録解除 アクションを機能させるには、送信者は URL ベースの登録解除情報ではなく mailto: を指定する必要があります。
また、そのヘッダーを設定すると、メッセージ インスタンスの unsubscribeEnabled プロパティが trueに設定され、unsubscribeData プロパティがヘッダー データに設定されます。
メッセージの unsubscribeEnabled プロパティが trueされている場合は、 購読解除 アクションを使用して、メッセージ送信者が管理するのと同様の将来のメッセージからユーザーをサブスクライブ解除できます。
登録解除アクションが成功すると、メッセージが [削除済みアイテム] フォルダーに移動します。 将来のメール配布からのユーザーの実際の除外は、送信者によって管理されます。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
✅ |
アクセス許可
この 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();
// 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