REST Resource: users.settings.filters

Referensi: Filter

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

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

string

Server yang menetapkan ID filter.
criteria

object (Criteria)

Kriteria pencocokan untuk filter.
action

object (Action)

Tindakan yang dijalankan 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. Menyertakan penerima di kolom header "to", "cc", dan "bcc". Anda cukup menggunakan bagian lokal dari 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 ditemukan dalam subjek pesan. Ruang kosong di akhir dan di awal akan dipangkas dan ruang di dekatnya diciutkan.
query

string

Hanya menampilkan pesan yang cocok dengan kueri yang ditentukan. Mendukung format kueri yang sama seperti 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 seperti kotak penelusuran Gmail. Misalnya, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Apakah pesan memiliki lampiran atau tidak.
excludeChats

boolean

Apakah respons harus mengecualikan chat.
size

integer

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

enum (SizeComparison)

Perbandingan ukuran pesan dalam byte dengan kolom ukuran.

SizeComparison

Menentukan cara kolom ukuran dibandingkan dengan ukuran pesan.

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

Tindakan

Serangkaian tindakan yang harus dilakukan pada pesan.

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

string

Daftar label untuk ditambahkan ke pesan.
removeLabelIds[]

string

Daftar label yang akan dihapus dari pesan.
forward

string

Alamat email yang akan menjadi tujuan penerusan pesan.

Metode

create

 Membuat filter.

delete

 Menghapus filter yang ditentukan segera dan secara permanen.

get

 Mendapatkan filter.

list

 Mencantumkan filter pesan pengguna Gmail.