REST Resource: users.settings.filters

Resource: Filter

Definisi resource untuk filter Gmail. Filter diterapkan ke pesan tertentu, bukan seluruh rangkaian email.

Representasi JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Kolom
id

string

ID filter yang ditetapkan server.
criteria

object (Criteria)

Kriteria pencocokan untuk filter.
action

object (Action)

Tindakan yang dilakukan filter.

Kriteria

Kriteria pencocokan pesan.

Representasi JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Kolom
from

string

Nama tampilan atau alamat email pengirim.
to

string

Nama tampilan atau alamat email penerima. Mencakup penerima di kolom header "to", "cc", dan "bcc". Anda dapat menggunakan bagian lokal alamat email. Misalnya, "example" dan "example@" cocok dengan "example@gmail.com". Kolom ini tidak peka huruf besar/kecil.
subject

string

Frasa yang tidak peka huruf besar/kecil yang ditemukan dalam subjek pesan. Spasi kosong di akhir dan di awal akan dipangkas dan spasi yang berdekatan akan diciutkan.
query

string

Hanya menampilkan pesan yang cocok dengan kueri yang ditentukan. Mendukung format kueri yang sama dengan kotak penelusuran Gmail. Misalnya, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Hanya menampilkan pesan yang tidak cocok dengan kueri yang ditentukan. Mendukung format kueri yang sama dengan kotak penelusuran Gmail. Misalnya, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Apakah pesan memiliki lampiran.
excludeChats

boolean

Apakah respons harus mengecualikan chat.
size

integer

Ukuran seluruh pesan RFC822 dalam byte, termasuk semua header dan lampiran.
sizeComparison

enum (SizeComparison)

Hubungan antara ukuran pesan dalam byte dengan kolom ukuran.

SizeComparison

Menentukan cara kolom ukuran harus dibandingkan dengan ukuran pesan.

Enum
unspecified
smaller Menemukan pesan yang ukurannya lebih kecil dari ukuran yang ditentukan.
larger Menemukan pesan yang ukurannya lebih besar dari ukuran yang ditentukan.

Tindakan

Kumpulan tindakan yang akan dilakukan pada pesan.

Representasi JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Kolom
addLabelIds[]

string

Daftar label yang akan ditambahkan ke pesan.
removeLabelIds[]

string

Daftar label yang akan dihapus dari pesan.
forward

string

Alamat email tujuan penerusan pesan.

Metode

create

 Membuat filter.

delete

 Menghapus filter yang ditentukan secara langsung dan permanen.

get

 Mendapatkan filter.

list

 Mencantumkan filter pesan pengguna Gmail.