Управляйте псевдонимами и подписями с помощью API Gmail.

В этом документе объясняется, как настроить псевдонимы для отправки писем и подписи в электронных письмах в API Gmail.

Псевдонимы «Отправить как» представляют собой адреса электронной почты, с которых учетная запись может отправлять письма. Каждая учетная запись всегда имеет как минимум один псевдоним, представляющий основной адрес электронной почты этой учетной записи.

Псевдонимы для отправки сообщений соответствуют функции «Отправлять письма от имени» в веб-интерфейсе Gmail.

Для управления подписями учетной записи можно также использовать псевдонимы. Для изменения подписей в электронных письмах необходимо иметь базовое представление о псевдонимах для отправки сообщений.

Информацию о том, как создавать , перечислять , получать , обновлять или удалять псевдонимы, см. в ресурсе settings.sendAs .

Создание и проверка псевдонимов

Перед использованием псевдонимов необходимо их создать . В некоторых случаях пользователям также необходимо подтвердить право собственности на псевдоним.

Если Gmail требует подтверждения пользователя для псевдонима, API возвращает псевдоним со VerificationStatus , равным pending . Gmail автоматически отправляет проверочное сообщение на целевой адрес электронной почты. Владелец адреса электронной почты должен пройти процесс подтверждения, прежде чем использовать псевдоним.

Псевдонимы, не требующие подтверждения, имеют статус подтверждения « accepted .

При необходимости используйте метод settings.sendAs.verify для повторной отправки запроса на подтверждение.

Настройки SMTP

Псевдонимы для внешних адресов должны отправлять почту через удаленный агент отправки почты SMTP (MSA). Для настройки SMTP MSA для псевдонима используйте поле smtpMsa для указания данных подключения.

Управление подписями

Вы также можете настроить подписи электронной почты для каждого псевдонима. Следующие примеры кода показывают, как установить подпись для основного адреса пользователя:

Java

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

Посмотреть на GitHub

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

Посмотреть на GitHub

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