Gerenciar aliases e assinaturas com a API Gmail

Este documento explica como configurar aliases de envio como e assinaturas de e-mail na API Gmail.

Os aliases de envio como representam os endereços de e-mail de que uma conta pode enviar e-mails. Cada conta sempre tem pelo menos um alias que representa o endereço de e-mail principal dela.

Os aliases de envio correspondem ao recurso "Enviar e-mail como" na interface da Web do Gmail.

Também é possível usar aliases para gerenciar assinaturas de uma conta. É necessário ter um conhecimento básico dos aliases de envio como para mudar as assinaturas de e-mail.

Para saber como criar, listar, receber, atualizar ou excluir pseudônimos, consulte o recurso settings.sendAs.

Criar e verificar aliases

É necessário criar aliases antes de usá-los. Em alguns casos, os usuários também precisam verificar a propriedade do alias.

Se o Gmail exigir a verificação do usuário para um alias, a API vai retornar o alias com um VerificationStatus de pending. O Gmail envia automaticamente uma mensagem de verificação para o endereço de e-mail de destino. O proprietário do endereço de e-mail precisa concluir o processo de verificação antes de usar o alias.

Os aliases que não exigem verificação têm um status de verificação accepted.

Use o método settings.sendAs.verify para reenviar a solicitação de verificação, se necessário.

Configurações de SMTP

Os aliases de endereços externos precisam enviar e-mails por um agente de envio de e-mails (MSA) SMTP remoto. Para configurar a MSA SMTP de um alias, use o campo smtpMsa para fornecer os detalhes da conexão.

Gerenciar assinaturas

Também é possível configurar assinaturas de e-mail para cada alias. Os exemplos de código a seguir mostram como definir a assinatura para o endereço principal do usuário:

Java

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

Ver no 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

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