إدارة الأسماء المستعارة والتوقيعات باستخدام Gmail API

يوضّح هذا المستند كيفية ضبط الأسماء المستعارة "إرسال باسم" وتوقيعات البريد الإلكتروني في Gmail API.

تمثّل العناوين البديلة "الإرسال باسم" عناوين البريد الإلكتروني التي يمكن للحساب إرسال الرسائل منها. يتضمّن كل حساب اسمًا مستعارًا واحدًا على الأقل يمثّل عنوان البريد الإلكتروني الأساسي للحساب.

تتطابق الأسماء المستعارة "إرسال كـ" مع ميزة "إرسال الرسائل كـ" في واجهة الويب الخاصة بـ Gmail.

يمكنك أيضًا استخدام العناوين البديلة لإدارة التواقيع الخاصة بحساب معيّن. يجب أن يكون لديك فهم أساسي لأسماء مستعارة خاصة بميزة "الإرسال باسم" لتغيير تواقيع البريد الإلكتروني.

للحصول على معلومات حول كيفية إنشاء أو إدراج أو الحصول على أو تعديل أو حذف أسماء مستعارة، يُرجى الاطّلاع على المورد settings.sendAs.

إنشاء أسماء مستعارة وتأكيدها

يجب إنشاء الأسماء المستعارة قبل استخدامها. في بعض الحالات، يجب أن يثبت المستخدمون أيضًا ملكية الاسم المستعار.

إذا كان Gmail يتطلّب إثبات ملكية المستخدم لاسم مستعار، ستعرض واجهة برمجة التطبيقات الاسم المستعار مع قيمة VerificationStatus تساوي pending. يرسل Gmail تلقائيًا رسالة تأكيد إلى عنوان البريد الإلكتروني المستهدف. على مالك عنوان البريد الإلكتروني إكمال عملية إثبات الملكية قبل استخدام الاسم المستعار.

تكون حالة التحقّق من الأسماء المستعارة التي لا تتطلّب إثبات الهوية هي accepted.

استخدِم طريقة settings.sendAs.verify لإعادة إرسال طلب إثبات الملكية إذا لزم الأمر.

إعدادات بروتوكول نقل البريد البسيط (SMTP)

يجب أن ترسل الأسماء المستعارة للعناوين الخارجية الرسائل الإلكترونية من خلال وكيل إرسال الرسائل الإلكترونية (MSA) عبر بروتوكول SMTP البعيد. لضبط بروتوكول نقل البريد البسيط (SMTP) اتفاقية خدمة رئيسية (MSA) لـ العنوان البديل للبريد الإلكتروني ، استخدِم الحقل smtpMsa لتوفير تفاصيل الاتصال.

إدارة التوقيعات

يمكنك أيضًا ضبط توقيعات البريد الإلكتروني لكل عنوان بديل للبريد الإلكتروني. توضّح نماذج الرموز البرمجية التالية كيفية ضبط التوقيع على العنوان الأساسي للمستخدم:

جافا

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

عرض على 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

عرض على 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()