Gmail フィルタを管理する

このドキュメントでは、Gmail API でフィルタを使用する方法について説明します。

settings.filters リソースを使用して、アカウントの高度なフィルタリング ルールを構成できます。フィルタを使用すると、受信メールの属性や内容に基づいて、ラベルを自動的に追加または削除したり、確認済みのエイリアスにメールを転送したりできます。

Gmail フィルタの作成、一覧表示、取得、削除の方法については、settings.filters リソースをご覧ください。

一致基準

送信者、件名、日付、サイズ、メッセージの内容などのプロパティでメッセージをフィルタします。フィルタは、メール スレッド全体ではなく、特定のメッセージにのみ適用されます。Gmail の高度な検索構文を使用するクエリは、フィルタでも使用できます。たとえば、一般的なフィルタ パターンには次のようなものがあります。

フィルタ	一致
criteria.from='[e-mail]'	[e-mail] からのメール
criteria.size=10485760 criteria.sizeComparison='larger'	サイズが 10 MB を超えるメール
criteria.hasAttachment=true	添付ファイル付きのメール
criteria.subject='[People with Pets]'	件名に [People with Pets] が含まれるメール
criteria.query='"my important project"'	my important project を含むメール
criteria.negatedQuery='"secret knock"'	secret knock を含まないメール

フィルタに複数の条件がある場合、フィルタが適用されるには、メッセージがすべての条件を満たしている必要があります。

操作

フィルタ条件に一致するメッセージに Action を適用します。Action を使用すると、確認済みのメールアドレスにメッセージを転送したり、ラベルを追加または削除したりできます。

ラベルを追加または削除して、メールの処理を変更します。たとえば、一般的なアクションには次のようなものがあります。

アクション	効果
action.removeLabelIds=['INBOX']	メールをアーカイブする（受信トレイをスキップする）
action.removeLabelIds=['UNREAD']	既読にする
action.removeLabelIds=['SPAM']	スパムとしてマークしない
action.removeLabelIds=['IMPORTANT']	重要マークを付けない
action.addLabelIds=['IMPORTANT']	重要マークを付ける
action.addLabelIds=['TRASH']	メールを削除する
action.addLabelIds=['STARRED']	スター付きとしてマークする
action.addLabelIds=['<user label id>']	ユーザー定義のラベルでメールにタグを付けます。フィルタごとに使用できるユーザー定義ラベルは 1 つのみです。

コードサンプル

次のコードサンプルは、メーリング リストのメッセージにラベルを付けてアーカイブする方法を示しています。

Java

gmail/snippets/src/main/java/CreateFilter.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.Filter;
import com.google.api.services.gmail.model.FilterAction;
import com.google.api.services.gmail.model.FilterCriteria;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Arrays;

/* Class to demonstrate the use of Gmail Create Filter API */
public class CreateFilter {
  /**
   * Create a new filter.
   *
   * @param labelId - ID of the user label to add
   * @return the created filter id, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String createNewFilter(String labelId) 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,
            GmailScopes.GMAIL_LABELS);
    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 {
      // Filter the mail from sender and archive them(skip the inbox)
      Filter filter = new Filter()
          .setCriteria(new FilterCriteria()
              .setFrom("[e-mail]"))
          .setAction(new FilterAction()
              .setAddLabelIds(Arrays.asList(labelId))
              .setRemoveLabelIds(Arrays.asList("INBOX")));

      Filter result = service.users().settings().filters().create("me", filter).execute();
      // Prints the new created filter ID
      System.out.println("Created filter " + result.getId());
      return result.getId();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to create filter: " + e.getDetails());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/settings snippets/create_filter.py

GitHub で表示

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def create_filter():
  """Create a filter.
  Returns: Draft object, including filter id.

  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)

    label_name = "IMPORTANT"
    filter_content = {
        "criteria": {"from": "[e-mail]"},
        "action": {
            "addLabelIds": [label_name],
            "removeLabelIds": ["INBOX"],
        },
    }

    # pylint: disable=E1101
    result = (
        service.users()
        .settings()
        .filters()
        .create(userId="me", body=filter_content)
        .execute()
    )
    print(f'Created filter with id: {result.get("id")}')

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

  return result.get("id")


if __name__ == "__main__":
  create_filter()

関連トピック

• メッセージを検索してフィルタする