Quản lý email đại diện và chữ ký bằng Gmail API

Tài liệu này giải thích cách định cấu hình bí danh gửi dưới tên mình và chữ ký email trong Gmail API.

Bí danh gửi dưới tên mình là địa chỉ email mà tài khoản có thể dùng để gửi thư. Mỗi tài khoản luôn có ít nhất một email đại diện cho địa chỉ email chính của tài khoản.

Bí danh gửi dưới tên mình tương ứng với tính năng "Gửi thư dưới tên mình" trong giao diện web của Gmail.

Bí danh cũng được dùng để quản lý chữ ký cho một tài khoản. Bạn phải hiểu rõ về bí danh gửi dưới tên mình để thay đổi chữ ký email.

Để biết thông tin về cách tạo, liệt kê, nhận, cập nhật hoặc xoá bí danh, hãy xem tài nguyên settings.SendAs.

Tạo và xác minh email đại diện

Bạn phải tạo bí danh trước khi sử dụng. Trong một số trường hợp, người dùng cũng phải xác minh quyền sở hữu của biệt hiệu.

Nếu Gmail yêu cầu người dùng xác minh một biệt hiệu, thì biệt hiệu đó sẽ được trả về cùng với VerificationStatus của pending. Một thư xác minh sẽ tự động được gửi đến địa chỉ email đích. Chủ sở hữu địa chỉ email phải hoàn tất quy trình xác minh trước khi có thể sử dụng địa chỉ email đó.

Những biệt danh không yêu cầu xác minh sẽ có trạng thái xác minh là accepted.

Sử dụng phương thức settings.sendAs.verify để gửi lại yêu cầu xác minh nếu cần.

Cài đặt SMTP

Bí danh cho địa chỉ bên ngoài phải gửi thư thông qua một chương trình hỗ trợ gửi thư (MSA) SMTP từ xa. Để định cấu hình SMTP MSA cho một email đại diện, hãy sử dụng trường smtpMsa để cung cấp thông tin chi tiết về kết nối.

Quản lý chữ ký

Bạn cũng có thể định cấu hình chữ ký email cho từng email đại diện. Các mã mẫu sau đây cho thấy cách đặt chữ ký cho địa chỉ chính của người dùng:

Java

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

Xem trên 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

Xem trên 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()