message : se désabonner

Article
03/15/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Envoie une demande par e-mail au nom de l’utilisateur connecté pour se désabonner d’une liste de distribution de courrier électronique. Utilise les informations contenues dans l’en-tête List-Unsubscribe .

Les expéditeurs de messages peuvent utiliser des listes de diffusion de manière conviviale en incluant une option permettant aux destinataires de se désinscrire. Pour ce faire, ils peuvent spécifier l’en-tête List-Unsubscribe dans chaque message suivant RFC-2369.

Note En particulier, pour que l’action de désabonnement fonctionne, l’expéditeur doit spécifier mailto: et non les informations de désabonnement basées sur une URL.

Si vous définissez cet en-tête, vous définissez également la propriété unsubscribeEnabled du message instance sur trueet la propriété unsubscribeData sur les données d’en-tête.

Si la propriété unsubscribeEnabled d’un message est true, vous pouvez utiliser l’action de désabonnement pour désinscrire l’utilisateur des messages futurs similaires gérés par l’expéditeur du message.

Une action de désinscription réussie déplace le message vers le dossier Éléments supprimés . L’exclusion réelle de l’utilisateur de la distribution de courrier future est gérée par l’expéditeur.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Mail.Send	Non disponible.
Déléguée (compte Microsoft personnel)	Mail.Send	Non disponible.
Application	Mail.Send	Non disponible.

Requête HTTP

POST /users/{id | userPrincipalName}/messages/{id}/unsubscribe

En-têtes de demande

Nom	Type	Description
Autorisation	string	Porteur {token}. Obligatoire.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 202 Accepted. Il ne retourne rien dans le corps de la réponse.

Exemple

Voici un exemple d’appel de cette API.

Demande

L’exemple suivant illustre une demande.

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

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


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

Importante



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)

Importante


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

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

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

Importante


<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Importante


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

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

Importante


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted

message : se désabonner

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires