Nachricht: Abbestellen

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Sendet im Namen des angemeldeten Benutzers eine E-Mail-Anforderung zum Abbestellen einer E-Mail-Verteilerliste. Verwendet die Informationen in der List-Unsubscribe Kopfzeile.

Nachrichtenabsender können Adressenlisten auf benutzerfreundliche Weise verwenden, indem sie eine Option für Empfänger enthalten, sich abzumelden. Sie können dies tun, indem sie den List-Unsubscribe Header in jeder Nachricht nach RFC-2369 angeben.

Hinweis Damit die Abmeldeaktion funktioniert, muss der Absender insbesondere URL-basierte Abmeldeinformationen angeben mailto: und keine URL-basierten Abmeldeinformationen.

Wenn Sie diesen Header festlegen, wird auch die Eigenschaft unsubscribeEnabled der Nachrichten-instance auf trueund die Eigenschaft unsubscribeData auf die Headerdaten festgelegt.

Wenn die unsubscribeEnabled-Eigenschaft einer Nachricht lautet true, können Sie die Aktion abbestellen verwenden, um den Benutzer von ähnlichen zukünftigen Nachrichten abzubestellen, wie sie vom Absender der Nachricht verwaltet werden.

Eine erfolgreiche Abmeldeaktion verschiebt die Nachricht in den Ordner "Gelöschte Elemente ". Der tatsächliche Ausschluss des Benutzers von der zukünftigen E-Mail-Verteilung wird vom Absender verwaltet.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Mail.Send Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Mail.Send Nicht verfügbar.
Anwendung Mail.Send Nicht verfügbar.

HTTP-Anforderung

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

Anforderungsheader

Name Typ Beschreibung
Authorization string Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 202 Accepted zurückgegeben. Sie gibt nichts im Antworttext zurück.

Beispiel

Hier ist ein Beispiel für den Aufruf dieser API.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/me/messages/{id}/unsubscribe

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 202 Accepted