Gérer les alias et les signatures avec l'API Gmail

Ce document explique comment configurer des alias "Envoyer sous" et des signatures d'e-mail dans l'API Gmail.

Les alias "Envoyer en tant que" représentent les adresses e-mail à partir desquelles un compte peut envoyer des e-mails. Chaque compte comporte toujours au moins un alias qui représente l'adresse e-mail principale du compte.

Les alias "Envoyer en tant que" correspondent à la fonctionnalité Envoyer des e-mails en tant que dans l'interface Web de Gmail.

Vous pouvez également utiliser des alias pour gérer les signatures d'un compte. Vous devez avoir une compréhension de base des alias "Envoyer en tant que" pour modifier les signatures d'e-mail.

Pour savoir comment créer, lister, obtenir, mettre à jour ou supprimer des alias, consultez la ressource settings.sendAs.

Créer et valider des alias

Vous devez créer des alias avant de les utiliser. Dans certains cas, les utilisateurs doivent également prouver qu'ils sont propriétaires de l'alias.

Si Gmail exige la validation de l'utilisateur pour un alias, l'API renvoie l'alias avec un VerificationStatus de pending. Gmail envoie automatiquement un message de validation à l'adresse e-mail cible. Le propriétaire de l'adresse e-mail doit effectuer la procédure de validation avant d'utiliser l'alias.

Les alias qui ne nécessitent pas de validation ont l'état de validation accepted.

Utilisez la méthode settings.sendAs.verify pour renvoyer la demande de validation si nécessaire.

Paramètres SMTP

Les alias pour les adresses externes doivent envoyer des e-mails via un agent d'envoi de messages (MSA) SMTP distant. Pour configurer le MSA SMTP pour un alias, utilisez le champ smtpMsa pour fournir les informations de connexion.

Gérer les signatures

Vous pouvez également configurer des signatures d'e-mail pour chaque alias. Les exemples de code suivants montrent comment définir la signature pour l'adresse principale de l'utilisateur :

Java

gmail/snippets/src/main/java/UpdateSignature.java
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
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()