Gmail API ile takma adları ve imzaları yönetme

Bu belgede, Gmail API'sinde farklı adreslerden gönderme takma adlarının ve e-posta imzalarının nasıl yapılandırılacağı açıklanmaktadır.

Farklı e-posta adresleri, bir hesabın e-posta gönderebileceği e-posta adreslerini temsil eder. Her hesabın, hesabın birincil e-posta adresini temsil eden en az bir takma adı vardır.

Gönderen takma adları, Gmail web arayüzündeki "Postayı şu adresten gönder" özelliğine karşılık gelir.

Ayrıca, bir hesabın imzalarını yönetmek için takma adları da kullanabilirsiniz. E-posta imzalarını değiştirmek için "farklı adreslerden gönderme" takma adları hakkında temel bilgilere sahip olmanız gerekir.

Takma ad oluşturma, listeleme, alma, güncelleme veya silme hakkında bilgi edinmek için settings.sendAs kaynağına bakın.

Takma ad oluşturma ve doğrulama

Kullanmadan önce takma ad oluşturmanız gerekir. Bazı durumlarda kullanıcıların, diğer adın sahipliğini de doğrulaması gerekir.

Gmail, bir takma ad için kullanıcı doğrulaması gerektiriyorsa API, takma adı pending VerificationStatus ile birlikte döndürür. Gmail, hedef e-posta adresine otomatik olarak bir doğrulama iletisi gönderir. E-posta adresinin sahibi, takma adı kullanmadan önce doğrulama sürecini tamamlamalıdır.

Doğrulama gerektirmeyen takma adların doğrulama durumu accepted olur.

Gerekirse doğrulama isteğini yeniden göndermek için settings.sendAs.verify yöntemini kullanın.

SMTP ayarları

Harici adreslerin diğer adları, uzak bir SMTP posta gönderme aracısı (MSA) üzerinden posta göndermelidir. Bir takma ad için SMTP MSA'yı yapılandırmak üzere bağlantı ayrıntılarını sağlamak için smtpMsa alanını kullanın.

İmzaları yönetme

Ayrıca her takma ad için e-posta imzalarını da yapılandırabilirsiniz. Aşağıdaki kod örneklerinde, kullanıcının birincil adresi için imzanın nasıl ayarlanacağı gösterilmektedir:

Java

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

GitHub'da göster

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

GitHub'da göster

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