Von der Email Settings API migrieren

In diesem Dokument erfahren Sie, wie Sie Ihre App von der eingestellten Email Settings API zur Gmail API migrieren.

Anfragen autorisieren

Wie die Email Settings API verwendet die Gmail API das OAuth 2.0-Protokoll zur Autorisierung von Anfragen. Ein wichtiger Unterschied besteht darin, dass Gmail API-Berechtigungen auf einen einzelnen Nutzer und nicht auf die gesamte Domain beschränkt sind. Wenn Sie ein Domainadministratorkonto autorisieren, können Sie also keine E-Mails für andere Nutzer in der Domain migrieren. Stattdessen müssen Sie Standarddienstkonten mit domänenweiter Autorisierung verwenden, die in der Admin-Konsole einer Zulassungsliste hinzugefügt werden, um das entsprechende Authentifizierungstoken zu generieren.

Für die Email Settings API wurde der Bereich verwendet:

https://apps-apis.google.com/a/feeds/emailsettings/2.0/

Die entsprechenden Bereiche in der Gmail API sind:

https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing

Protokolländerungen

Die Email Settings API verwendet das XML-basierte GDATA-Protokoll. Die Gmail API verwendet JSON. Da Einstellungen hauptsächlich aus Schlüssel-Wert-Paaren bestehen, sind die Nutzlasten zwischen den Versionen konzeptionell ähnlich.

Beispiel für das Erstellen eines Labels:

Email Settings API

POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
  <apps:property name="label" value="status updates" />
</atom:entry>

Gmail API

POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
   "name": "status updates"
}

Verwenden Sie die bereitgestellten Clientbibliotheken, anstatt das Protokoll direkt zu implementieren.

Labels verwalten

Verwenden Sie zum Verwalten von Labels in der Gmail API die Ressource labels.

Alte Einstellung Neue Einstellung Hinweise
labelId id
Label name
unreadCount messagesUnread
Sichtbarkeit labelListVisibility SHOW heißt jetzt labelShow
HIDE heißt jetzt labelHide

Sonstige Änderungen:

  • Beim Aktualisieren oder Löschen von Labels wird in der Gmail API anhand der ID und nicht anhand des Namens auf Labels verwiesen.

Filter verwalten

Verwenden Sie zum Verwalten von Filtern in der Gmail API die Ressource settings.filters.

Alte Einstellung Neue Einstellung Hinweise
von criteria.from
zu criteria.to
Betreff criteria.subject
hasTheWord criteria.query
doesNotHaveTheWord criteria.negatedQuery
hasAttachment criteria.hasAttachment
shouldArchive action.removeLabelIds INBOX als Label-ID verwenden
shouldMarkAsRead action.removeLabelIds UNREAD als Label-ID verwenden
shouldStar action.addLabelIds STARRED als Label-ID verwenden
Label action.addLabelIds ID des hinzuzufügenden Labels verwenden
forwardTo action.forward
shouldTrash action.addLabelIds TRASH als Label-ID verwenden
neverSpam action.removeLabelIds SPAM als Label-ID verwenden

Sonstige Änderungen:

  • Wenn ein Nutzerlabel, das Sie hinzufügen möchten, noch nicht vorhanden ist, müssen Sie es explizit mit der Methode labels.create erstellen.

„Senden als“-Aliasse verwalten

Verwenden Sie zum Verwalten von „Senden als“-Aliasen in der Gmail API die Ressource settings.sendAs.

Alte Einstellung Neue Einstellung
name displayName
Adresse sendAsEmail
replyTo replyToAddress
makeDefault isDefault

Webclips verwalten

Webclip-Einstellungen sind in der Gmail API nicht verfügbar.

Automatische Weiterleitung verwalten

Verwenden Sie die Ressource settings, um die automatische Weiterleitung in der Gmail API zu verwalten.

Alte Einstellung Neue Einstellung Hinweise
aktivieren aktiviert
forwardTo emailAddress
Aktion disposition KEEP heißt jetzt leaveInInbox
ARCHIVE heißt jetzt archive
DELETE heißt jetzt trash
MARK_READ heißt jetzt markRead

Sonstige Änderungen:

  • Sie müssen Weiterleitungsadressen erstellen und bestätigen, bevor Sie sie verwenden können.
  • Verwenden Sie zum Verwalten von Weiterleitungsadressen die Ressource settings.forwardingAddresses.

POP-Einstellungen verwalten

Verwenden Sie zum Verwalten des POP-Zugriffs in der Gmail API die Ressource settings.

Alte Einstellung Neue Einstellung Hinweise
aktivieren accessWindow Deaktiviert, wenn disabled festgelegt ist
enableFor accessWindow ALL_MAIL heißt jetzt allMail
MAIL_FROM_NOW_ON heißt jetzt fromNowOn
Aktion disposition KEEP heißt jetzt leaveInInbox
ARCHIVE heißt jetzt archive
DELETE heißt jetzt trash
MARK_READ heißt jetzt markRead

IMAP-Einstellungen verwalten

Verwenden Sie zum Verwalten des IMAP-Zugriffs in der Gmail API die Ressource settings.

Alte Einstellung Neue Einstellung
aktivieren aktiviert

Einstellungen für automatische Antworten verwalten

Verwenden Sie die Ressource settings, um die automatische Antwort für Abwesenheitsnotizen in der Gmail API zu verwalten.

Alte Einstellung Neue Einstellung
contactsOnly restrictToContacts
domainOnly restrictToDomain
aktivieren enableAutoReply
endDate endTime
Nachricht responseBodyHtml
responseBodyPlainText
startDate startTime
Betreff responseSubject

Signatureinstellungen verwalten

Verwenden Sie zum Verwalten von E‑Mail-Signaturen in der Gmail API die Ressource settings.sendAs.

Alte Einstellung Neue Einstellung
Signatur Signatur

Sonstige Änderungen:

  • Signaturen werden jetzt pro Alias verwaltet.

Spracheinstellungen verwalten

Verwenden Sie die Ressource settings, um Spracheinstellungen in der Gmail API zu verwalten.

Alte Einstellung Neue Einstellung
Sprache displayLanguage

Weitere Informationen finden Sie unter Spracheinstellungen verwalten.

Delegierungseinstellungen verwalten

Verwenden Sie zum Verwalten der Stellvertretung in der Gmail API die Ressource settings.delegates.

Alte Einstellung Neue Einstellung
Adresse delegateEmail
Status verificationStatus

Sonstige Änderungen:

  • Allgemein
    • Damit eine der Delegierungsmethoden (einschließlich settings.delegates.create) verwendet werden kann, muss Gmail für den delegierenden Nutzer aktiviert sein. Das bedeutet beispielsweise, dass der delegierende Nutzer in Google Workspace nicht gesperrt werden kann.
    • Sie können keinen E-Mail-Alias als E-Mail-Eingabe für einen Bevollmächtigten für eine der neuen Methoden verwenden. Sie müssen sich auf einen delegierten Nutzer mit seiner primären E‑Mail-Adresse beziehen.
  • settings.delegates.create
    • Mit dieser Methode können Sie jetzt Stellvertreterbeziehungen über mehrere Domains hinweg erstellen, die zur selben Google Workspace-Organisation gehören.
    • Sie können diese Methode jetzt für Nutzer verwenden, die bei der nächsten Anmeldung ihr Passwort ändern müssen.
    • Bei Erfolg gibt diese Methode eine settings.delegates-Ressource im Antworttext zurück, nicht einen leeren Antworttext.
    • Wenn der delegierende oder der delegierte Nutzer deaktiviert ist (z. B. in Google Workspace gesperrt), schlägt diese Methode mit einem HTTP-4XX-Fehler anstelle eines HTTP-500-Fehlers fehl.
  • settings.delegates.delete
    • Sie können diese Methode jetzt verwenden, um Delegierte mit beliebigen VerificationStatus zu löschen, nicht nur Delegierte, die accepted oder expired sind.
  • settings.delegates.get
    • Dies ist eine neue Methode, die je nach Bedarf möglicherweise der Methode settings.delegates.list vorzuziehen ist.

Allgemeine Einstellungen verwalten

Allgemeine Einstellungen sind in der Gmail API nicht verfügbar.