Gérer les alias

Les alias d'envoi 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 pour représenter l'adresse e-mail principale du compte.

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

Les alias permettent également de gérer les signatures d'un compte. Pour pouvoir modifier les signatures d'e-mail, vous devez disposer de connaissances de base sur les alias d'envoi en tant que. La vidéo ci-dessus vous montre comment lire en boucle les alias d'envoi en tant que et modifier la signature de l'adresse e-mail principale d'un utilisateur.

Pour en savoir plus sur la façon de créer, répertorier, get, mettre à jour ou supprimer des alias, consultez la SendAs documentation de référence.

Créer et valider des alias

Vous devez créer les alias avant de les utiliser. Dans certains cas, les utilisateurs doivent également valider la propriété de l'alias.

Si Gmail exige la validation de l'utilisateur pour un alias, l'alias est renvoyé avec l'état pending. Un message de validation est automatiquement envoyé à l'adresse e-mail cible. Le propriétaire de l'adresse e-mail doit terminer la procédure de validation avant de pouvoir l'utiliser.

L'état de validation des alias qui ne nécessitent pas de validation est accepted.

Utilisez la méthode verify pour renvoyer la requête de validation si nécessaire.

Paramètres SMTP

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

Gérer les signatures

Vous pouvez également configurer des signatures d'e-mail pour chaque alias. Par exemple, pour 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/extraits/settings/extraits/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()