Aliasse und Signaturen mit der Gmail API verwalten

In diesem Dokument wird erläutert, wie Sie „Senden als“-Aliasse und E‑Mail-Signaturen in der Gmail API konfigurieren.

„Senden als“-Aliasse sind die E-Mail-Adressen, über die ein Konto E-Mails senden kann. Jedes Konto hat immer mindestens einen Alias, der die primäre E-Mail-Adresse des Kontos darstellt.

„Senden als“-Aliasse entsprechen der Funktion E-Mails senden als in der Gmail-Weboberfläche.

Aliasse werden auch verwendet, um Signaturen für ein Konto zu verwalten. Sie benötigen grundlegende Kenntnisse von „Senden als“-Aliasen, um E‑Mail-Signaturen zu ändern.

Informationen zum Erstellen, Auflisten, Abrufen, Aktualisieren oder Löschen von Aliasen finden Sie in der settings.SendAs-Ressource.

Aliasse erstellen und bestätigen

Sie müssen Aliase erstellen, bevor Sie sie verwenden können. In einigen Fällen müssen Nutzer auch die Inhaberschaft des Alias bestätigen.

Wenn für einen Alias eine Nutzerbestätigung in Gmail erforderlich ist, wird der Alias mit einem VerificationStatus von pending zurückgegeben. Eine Bestätigungsnachricht wird automatisch an die Ziel-E-Mail-Adresse gesendet. Der Inhaber der E‑Mail-Adresse muss die Bestätigung abschließen, bevor er sie verwenden kann.

Aliasse, für die keine Bestätigung erforderlich ist, haben den Bestätigungsstatus accepted.

Verwenden Sie bei Bedarf die Methode settings.sendAs.verify, um die Bestätigungsanfrage noch einmal zu senden.

SMTP-Einstellungen

Für Aliase für externe Adressen sollten E-Mails über einen Remote-SMTP-Mail-Sending-Agent (MSA) gesendet werden. Wenn Sie den SMTP-MSA für einen Alias konfigurieren möchten, geben Sie die Verbindungsdetails im Feld smtpMsa an.

Signaturen verwalten

Sie können auch E-Mail-Signaturen für jeden Alias konfigurieren. Die folgenden Codebeispiele zeigen, wie Sie die Signatur für die primäre Adresse des Nutzers festlegen:

Java

gmail/snippets/src/main/java/UpdateSignature.java

Auf GitHub ansehen

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.ListSendAsResponse;
import com.google.api.services.gmail.model.SendAs;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;

/* Class to demonstrate the use of Gmail Update Signature API */
public class UpdateSignature {
  /**
   * Update the gmail signature.
   *
   * @return the updated signature id , {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String updateGmailSignature() throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_BASIC);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    try {
      SendAs primaryAlias = null;
      ListSendAsResponse aliases = service.users().settings().sendAs().list("me").execute();
      for (SendAs alias : aliases.getSendAs()) {
        if (alias.getIsPrimary()) {
          primaryAlias = alias;
          break;
        }
      }
      // Updating a new signature
      SendAs aliasSettings = new SendAs().setSignature("Automated Signature");
      SendAs result = service.users().settings().sendAs().patch(
              "me",
              primaryAlias.getSendAsEmail(),
              aliasSettings)
          .execute();
      //Prints the updated signature
      System.out.println("Updated signature - " + result.getSignature());
      return result.getSignature();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to update signature: " + e.getDetails());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/settings snippets/update_signature.py

Auf GitHub ansehen

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def update_signature():
  """Create and update signature in gmail.
  Returns:Draft object, including updated signature.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    primary_alias = None

    # pylint: disable=E1101
    aliases = service.users().settings().sendAs().list(userId="me").execute()
    for alias in aliases.get("sendAs"):
      if alias.get("isPrimary"):
        primary_alias = alias
        break

    send_as_configuration = {
        "displayName": primary_alias.get("sendAsEmail"),
        "signature": "Automated Signature",
    }

    # pylint: disable=E1101
    result = (
        service.users()
        .settings()
        .sendAs()
        .patch(
            userId="me",
            sendAsEmail=primary_alias.get("sendAsEmail"),
            body=send_as_configuration,
        )
        .execute()
    )
    print(f'Updated signature for: {result.get("displayName")}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    result = None

  return result.get("signature")


if __name__ == "__main__":
  update_signature()