ניהול ההעברה

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

  • כתובת האימייל אומתה. למידע נוסף, ראו יצירה ואימות של כתובות להעברת אימיילים
  • כתובת האימייל שייכת לאותו דומיין של השולח.
  • כתובת האימייל שייכת לתת-דומיין באותו דומיין של השולח.
  • כתובת האימייל שייכת לכתובת אימייל חלופית של דומיין שהוגדרה כחלק מאותו חשבון Google Workspace.

אם כתובת האימייל להעברה לא עומדת באחד מהכללים האלה, ההגדרה של ההעברה באמצעות ה-API תיכשל.

מידע נוסף על create, הצגת רשימה, אחזור ומחיקה של כתובות להעברת אימייל זמין במאמר מידע על ForwardingAddresses.

במאמר הסבר על ההגדרות מוסבר איך לקבל או לעדכן את הגדרות ההעברה.

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

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

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

כתובות להעברת אימייל שלא מחייבות אימות מקבלות את סטטוס האימות accepted.

הפעלת העברה אוטומטית

כדי להפעיל את ההעברה האוטומטית בחשבון, צריך להפעיל את השיטה updateAutoForwarding. כדי לבצע את הקריאה, צריך גם כתובת להעברת אימיילים רשומה ומאומתת וגם פעולה שצריך לבצע לגבי הודעות שהועברו.

לדוגמה, כדי להפעיל העברה אוטומטית ולהעביר הודעות שהועברו לאשפה:

Java

gmail/snippets/src/main/java/EnableForwarding.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.AutoForwarding;
import com.google.api.services.gmail.model.ForwardingAddress;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;

/* Class to demonstrate the use of Gmail Enable Forwarding API */
public class EnableForwarding {
  /**
   * Enable the auto-forwarding for an account.
   *
   * @param forwardingEmail - Email address of the recipient whose email will be forwarded.
   * @return forwarding id and metadata, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static AutoForwarding enableAutoForwarding(String forwardingEmail) 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_SHARING);
    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 {
      // Enable auto-forwarding and move forwarded messages to the trash
      ForwardingAddress address = new ForwardingAddress()
          .setForwardingEmail(forwardingEmail);
      ForwardingAddress createAddressResult = service.users().settings().forwardingAddresses()
          .create("me", address).execute();
      if (createAddressResult.getVerificationStatus().equals("accepted")) {
        AutoForwarding autoForwarding = new AutoForwarding()
            .setEnabled(true)
            .setEmailAddress(address.getForwardingEmail())
            .setDisposition("trash");
        autoForwarding =
            service.users().settings().updateAutoForwarding("me", autoForwarding).execute();
        System.out.println(autoForwarding.toPrettyString());
        return autoForwarding;
      }
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to enable forwarding: " + e.getDetails());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/settings snippets/enable_forwarding.py
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def enable_forwarding():
  """Enable email forwarding.
  Returns:Draft object, including forwarding id and result meta data.

  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)

    address = {"forwardingEmail": "gduser1@workspacesamples.dev"}

    # pylint: disable=E1101
    result = (
        service.users()
        .settings()
        .forwardingAddresses()
        .create(userId="me", body=address)
        .execute()
    )
    if result.get("verificationStatus") == "accepted":
      body = {
          "emailAddress": result.get("forwardingEmail"),
          "enabled": True,
          "disposition": "trash",
      }
      # pylint: disable=E1101
      result = (
          service.users()
          .settings()
          .updateAutoForwarding(userId="me", body=body)
          .execute()
      )
      print(f"Forwarding is enabled : {result}")

  except HttpError as error:
    print(f"An error occurred: {error}")
    result = None

  return result


if __name__ == "__main__":
  enable_forwarding()

כדי להשבית את ההעברה האוטומטית, קוראים ל-updateAutoForwarding ומגדירים את המאפיין enabled לערך false.

העברת הודעות ספציפיות

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