転送の管理

設定を使用して、アカウントの転送を設定できます。転送用メールアドレスとして使用するには、次のいずれかの条件を満たしている必要があります。

• メールアドレスが確認されました。詳しくは、転送用アドレスの作成と確認をご覧ください。
• メールアドレスが送信者と同じドメインに属している。
• メールアドレスが、送信者と同じドメイン内のサブドメインに属している。
• メールアドレスは、同じ Google Workspace アカウントの一部として構成されたドメイン エイリアスに属しています。

転送用メールアドレスがこれらのルールのいずれかに準拠していない場合、API を使用した転送の設定は失敗します。

転送先アドレスの作成、一覧表示、取得、削除の方法については、ForwardingAddresses リファレンスをご覧ください。

転送設定を取得または更新する方法については、設定項目の詳細をご覧ください。

転送先アドレスの作成と確認

転送アドレスは、使用する前に作成する必要があります。場合によっては、ユーザーはアドレスの所有権も確認する必要があります。

Gmail で転送先アドレスのユーザー確認が必要な場合、アドレスはステータス pending で返されます。確認メッセージが対象のメールアドレスに自動的に送信されます。メールアドレスを使用するには、その所有者が確認プロセスを完了する必要があります。

確認を必要としない転送先アドレスの確認ステータスは accepted です。

自動転送を有効にする

updateAutoForwarding メソッドを呼び出して、アカウントの自動転送を有効にします。この呼び出しには、登録済みで確認済みの転送アドレスと、転送されたメッセージに対して行うアクションの両方が必要です。

たとえば、自動転送を有効にして、転送されたメールをゴミ箱に移動するには:

Java

gmail/snippets/src/main/java/EnableForwarding.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.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

GitHub で表示

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": "[e-mail]"}

    # 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 に設定します。

特定のメッセージを転送する

自動転送では、受信したすべてのメールが転送先のアカウントに送信されます。メールを選択的に転送するには、フィルタを使用して、メールの属性またはコンテンツに応じて転送するルールを作成します。