مدیریت نام‌های مستعار و امضاها با Gmail API

این سند نحوه پیکربندی نام‌های مستعار ارسالی و امضاهای ایمیل را در Gmail API توضیح می‌دهد.

نام‌های مستعار ارسالی، آدرس‌های ایمیلی را نشان می‌دهند که یک حساب کاربری می‌تواند از طریق آنها ایمیل ارسال کند. هر حساب کاربری همیشه حداقل یک نام مستعار دارد که نشان دهنده آدرس ایمیل اصلی آن حساب کاربری است.

نام‌های مستعار «ارسال به عنوان» با ویژگی «ارسال ایمیل به عنوان» در رابط وب Gmail مطابقت دارند.

نام‌های مستعار همچنین برای مدیریت امضاهای یک حساب کاربری استفاده می‌شوند. برای تغییر امضای ایمیل، باید درک اولیه‌ای از نام‌های مستعار ارسالی داشته باشید.

برای اطلاعات در مورد نحوه ایجاد ، فهرست کردن ، دریافت ، به‌روزرسانی یا حذف نام‌های مستعار، به منبع settings.SendAs مراجعه کنید.

ایجاد و تأیید نام‌های مستعار

قبل از استفاده از نام‌های مستعار، باید آنها را ایجاد کنید . در برخی موارد، کاربران باید مالکیت نام‌های مستعار را نیز تأیید کنند.

اگر جیمیل برای یک نام مستعار نیاز به تأیید کاربر داشته باشد، نام مستعار با VerificationStatus در حال بررسی ( pending برگردانده می‌شود. یک پیام تأیید به طور خودکار به آدرس ایمیل هدف ارسال می‌شود. صاحب آدرس ایمیل قبل از اینکه بتواند از آن استفاده کند، باید فرآیند تأیید را تکمیل کند.

نام‌های مستعاری که نیازی به تأیید ندارند، وضعیت تأییدشان accepted » است.

در صورت نیاز، از متد settings.sendAs.verify برای ارسال مجدد درخواست تأیید استفاده کنید.

تنظیمات SMTP

نام‌های مستعار برای آدرس‌های خارجی باید از طریق یک عامل ارسال ایمیل SMTP (MSA) از راه دور، ایمیل ارسال کنند. برای پیکربندی SMTP MSA برای یک نام مستعار، از فیلد smtpMsa برای ارائه جزئیات اتصال استفاده کنید.

مدیریت امضاها

همچنین می‌توانید امضاهای ایمیل را برای هر نام مستعار پیکربندی کنید. نمونه‌های کد زیر نحوه تنظیم امضا برای آدرس اصلی کاربر را نشان می‌دهند:

جاوا

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

مشاهده در گیت‌هاب

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;
  }
}

پایتون

gmail/snippet/settings snippets/update_signature.py

مشاهده در گیت‌هاب

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