Mengelola alias dan tanda tangan dengan Gmail API

Dokumen ini menjelaskan cara mengonfigurasi alias kirim sebagai dan tanda tangan email di Gmail API.

Alias kirim sebagai mewakili alamat email dari mana akun dapat mengirim email. Setiap akun selalu memiliki setidaknya satu alias yang merepresentasikan alamat email utama akun tersebut.

Alias kirim sebagai sesuai dengan fitur "Kirim email sebagai" di antarmuka web Gmail.

Alias juga digunakan untuk mengelola tanda tangan akun. Anda harus memiliki pemahaman dasar tentang alias kirim sebagai untuk mengubah tanda tangan email.

Untuk mengetahui informasi tentang cara membuat, mencantumkan, mendapatkan, memperbarui, atau menghapus alias, lihat resource settings.SendAs.

Membuat dan memverifikasi alias

Anda harus membuat alias sebelum menggunakannya. Dalam beberapa kasus, pengguna juga harus memverifikasi kepemilikan alias.

Jika Gmail mewajibkan verifikasi pengguna untuk alias, alias akan ditampilkan dengan VerificationStatus pending. Pesan verifikasi akan otomatis dikirim ke alamat email target. Pemilik alamat email harus menyelesaikan proses verifikasi sebelum dapat menggunakannya.

Alias yang tidak memerlukan verifikasi memiliki status verifikasi accepted.

Gunakan metode settings.sendAs.verify untuk mengirim ulang permintaan verifikasi jika diperlukan.

Setelan SMTP

Alias untuk alamat eksternal harus mengirim email melalui agen pengiriman email (MSA) SMTP jarak jauh. Untuk mengonfigurasi MSA SMTP untuk alias, gunakan kolom smtpMsa untuk memberikan detail koneksi.

Mengelola tanda tangan

Anda juga dapat mengonfigurasi tanda tangan email untuk setiap alias. Contoh kode berikut menunjukkan cara menetapkan tanda tangan untuk alamat utama pengguna:

Java

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

Lihat di 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

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