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

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

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

行動

メールに対して実行する一連の操作です。

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

string

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

string

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

string

メッセージの転送先のメールアドレス

Methods

create

 フィルタを作成します。

delete

 指定したフィルタを直ちに完全に削除します。

get

 フィルタを取得します。

list

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