ניהול כינויים וחתימות באמצעות Gmail API

במאמר הזה מוסבר איך להגדיר כינויים לשליחה וחתימות אימייל ב-Gmail API.

כתובות אימייל חלופיות לשליחה מייצגות את כתובות האימייל שמהן אפשר לשלוח אימייל מחשבון. לכל חשבון יש תמיד לפחות כתובת אימייל חלופית אחת שמייצגת את כתובת האימייל הראשית של החשבון.

כינויים לשליחה תואמים לתכונה "שליחת אימייל בשם" בממשק האינטרנט של Gmail.

אפשר גם להשתמש בכינויים כדי לנהל חתימות בחשבון. כדי לשנות חתימות באימייל, אתם צריכים להבין את המושג 'כתובות אימייל חלופיות לשליחה'.

מידע על יצירה, הצגה, קבלת, עדכון או מחיקה של כתובות אימייל חלופיות זמין במאמר בנושא settings.SendAs.

יצירה ואימות של כתובות אימייל חלופיות

צריך ליצור כינויים לפני שמשתמשים בהם. במקרים מסוימים, המשתמשים צריכים גם לאמת את הבעלות על הכינוי.

אם Gmail דורש אימות משתמש עבור אימייל חלופי, האימייל החלופי מוחזר עם הערך VerificationStatus של pending. הודעת אימות נשלחת באופן אוטומטי לכתובת האימייל של היעד. הבעלים של כתובת האימייל צריך להשלים את תהליך האימות כדי שיוכל להשתמש בה.

כינויים שלא דורשים אימות מקבלים את סטטוס האימות accepted.

במקרה הצורך, אפשר להשתמש בשיטה settings.sendAs.verify כדי לשלוח מחדש את בקשת האימות.

הגדרות SMTP

כתובות אימייל חלופיות לכתובות חיצוניות צריכות לשלוח אימייל דרך סוכן מרוחק לשליחת אימייל (MSA) של SMTP. כדי להגדיר את שרת ה-SMTP MSA עבור כתובת אימייל חלופית, משתמשים בשדה smtpMsa כדי לספק את פרטי החיבור.

ניהול חתימות

אפשר גם להגדיר חתימות אימייל לכל כתובת אימייל חלופית. בדוגמאות הקוד הבאות אפשר לראות איך מגדירים את החתימה לכתובת הראשית של המשתמש:

Java

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