Gestire gli alias e le firme con l'API Gmail

Questo documento spiega come configurare gli alias Invia come e le firme email nell'API Gmail.

Gli alias Invia come rappresentano gli indirizzi email da cui un account può inviare email. Ogni account ha sempre almeno un alias che rappresenta l'indirizzo email principale dell'account.

Gli alias Invia come corrispondono alla funzionalità "Invia posta come" nell'interfaccia web di Gmail.

Gli alias vengono utilizzati anche per gestire le firme di un account. Per modificare le firme email, devi avere una conoscenza di base degli alias Invia come.

Per informazioni su come creare, elencare, ottenere, aggiornare o eliminare gli alias, consulta la risorsa settings.SendAs.

Creare e verificare gli alias

Devi creare gli alias prima di utilizzarli. In alcuni casi, gli utenti devono anche verificare la proprietà dell'alias.

Se Gmail richiede la verifica dell'utente per un alias, l'alias viene restituito con un VerificationStatus di pending. Un messaggio di verifica viene inviato automaticamente all'indirizzo email di destinazione. Il proprietario dell'indirizzo email deve completare la procedura di verifica prima di poterlo utilizzare.

Gli alias che non richiedono la verifica hanno lo stato di verifica accepted.

Utilizza il metodo settings.sendAs.verify per inviare di nuovo la richiesta di verifica, se necessario.

Impostazioni SMTP

Gli alias per gli indirizzi esterni devono inviare posta tramite un agente di invio della posta SMTP (MSA) remoto. Per configurare l'MSA SMTP per un alias, utilizza il campo smtpMsa per fornire i dettagli della connessione.

Gestire le firme

Puoi anche configurare le firme email per ogni alias. I seguenti esempi di codice mostrano come impostare la firma per l'indirizzo principale dell'utente:

Java

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

Visualizza su 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

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