message: unsubscribe

[アーティクル]
10/28/2023

名前空間: 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();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users messages unsubscribe post --user-id {user-id} --message-id {message-id}

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.Me().Messages().ByMessageId("message-id").Unsubscribe().Post(context.Background(), nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// 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();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/me/messages/{id}/unsubscribe')
	.version('beta')
	.post();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->messages()->byMessageId('message-id')->unsubscribe()->post()->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Users.Actions

# A UPN can also be used as -UserId.
Invoke-MgBetaUnsubscribeUserMessage -UserId $userId -MessageId $messageId

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.me.messages.by_message_id('message-id').unsubscribe.post()

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

message: unsubscribe

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース