REST Resource: users.settings.filters

リソース: フィルタ

Gmail フィルタのリソース定義。フィルタは、メールスレッド全体ではなく、特定のメッセージに適用されます。

JSON 表現 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
フィールド
id

string

サーバーから割り当てられたフィルタの ID。
criteria

object (Criteria)

フィルタの一致条件。
action

object (Action)

フィルタによって実行されるアクション。

条件

メッセージの一致条件。

JSON 表現 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
フィールド
from

string

送信者の表示名またはメールアドレス。
to

string

受信者の表示名またはメールアドレス。[To]、[Cc]、[Bcc] ヘッダー フィールドの受信者が含まれます。メールアドレスのローカル部分のみを使用できます。たとえば、「example」と「example@」はどちらも「example@gmail.com」と一致します。このフィールドでは大文字と小文字は区別されません。
subject

string

メッセージの件名に含まれるフレーズ（大文字と小文字は区別されません）。先頭と末尾の空白文字は削除され、隣接するスペースは折りたたまれます。
query

string

指定したクエリに一致するメッセージのみを返します。Gmail の検索ボックスと同じクエリ形式をサポートしています。例: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
negatedQuery

string

指定したクエリに一致しないメッセージのみを返します。Gmail の検索ボックスと同じクエリ形式をサポートしています。例: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
hasAttachment

boolean

メッセージに添付ファイルがあるかどうか。
excludeChats

boolean

レスポンスからチャットを除外するかどうか。
size

integer

RFC822 メッセージ全体のサイズ（バイト単位）。すべてのヘッダーと添付ファイルが含まれます。
sizeComparison

enum (SizeComparison)

メッセージのサイズ（バイト単位）と size フィールドの比較方法。

SizeComparison

size フィールドとメッセージ サイズの比較方法を指定します。

列挙型
unspecified
smaller 指定したサイズより小さいメッセージを検索します。
larger 指定したサイズより大きいメッセージを検索します。

アクション

メッセージに対して実行する一連のアクション。

JSON 表現 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
フィールド
addLabelIds[]

string

メッセージに追加するラベルのリスト。
removeLabelIds[]

string

メッセージから削除するラベルのリスト。
forward

string

メッセージの転送先のメールアドレス。これにより、メッセージはこのフィールドで指定されたアドレスにリダイレクトされ、元の送信者は [From] フィールドに保持されます。

メソッド

create

 フィルタを作成します。

delete

 指定したフィルタを即時かつ完全に削除します。

get

 フィルタを取得します。

list

 Gmail ユーザーのメッセージ フィルタを一覧表示します。