Gérer les alias

Les alias "Envoyer en tant que" représentent les adresses e-mail auxquelles un compte peut accéder à partir duquel vous souhaitez envoyer des messages. Chaque compte est toujours associé à au moins un alias pour représenter principale du compte.

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

Les alias sont également utilisés pour gérer les signatures d'un compte. Connaissances de base d'alias "Envoyer en tant que" sont nécessaires pour pouvoir modifier les signatures d'e-mail. La vidéo ci-dessus vous montre comment lire en boucle les alias "Envoyer en tant que" et modifier le paramètre signature de l'adresse e-mail principale d'un utilisateur.

Pour savoir comment create, list, get, mise à jour, ou supprimer des alias, consultez les SendAs référence.

Créer et vérifier des alias

Vous devez créer. avant leur utilisation. Dans certains cas, les utilisateurs doivent également confirmer qu'ils sont propriétaires un alias.

Si Gmail exige une validation de l'utilisateur pour un alias, l'alias est renvoyé avec le paramètre état pending. Un message de vérification est automatiquement envoyé au votre adresse e-mail cible. Le propriétaire de l'adresse e-mail doit effectuer la validation avant de pouvoir être utilisées.

Les alias qui ne nécessitent pas de validation sont associés à l'état de validation accepted.

Utilisez la méthode verify pour Si nécessaire, renvoyez la demande de validation.

Paramètres SMTP

Les alias d'adresses externes doivent envoyer les e-mails via un serveur SMTP distant un agent envoyant des e-mails. Pour configurer le contrat-cadre de services SMTP pour un alias, utilisez le champ smtpMsa pour fournir les détails de la connexion.

Gérer les signatures

Vous pouvez également configurer des signatures d'e-mail pour chaque alias. Par exemple, pour définir le signature pour l'adresse principale de l'utilisateur:

Java

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

Afficher sur 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/extraits/paramètres extraits/update_signature.py

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