REST Resource: users.settings.filters

ทรัพยากร: ตัวกรอง

คําจํากัดความทรัพยากรสําหรับตัวกรอง Gmail ตัวกรองจะมีผลกับข้อความที่เฉพาะเจาะจงแทนชุดข้อความอีเมลทั้งหมด

การแสดง JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
ช่อง
id

string

รหัสที่เซิร์ฟเวอร์กำหนดให้กับตัวกรอง
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

ชื่อที่แสดงหรืออีเมลของผู้รับ รวมผู้รับในช่องส่วนหัว "ถึง" "สำเนา" และ "สำเนาลับ" คุณใช้เพียงส่วนชื่อของอีเมลได้ เช่น ทั้ง "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)

ความสัมพันธ์ระหว่างขนาดข้อความเป็นไบต์กับช่องขนาด

SizeComparison

กำหนดวิธีเปรียบเทียบช่องขนาดกับขนาดข้อความ

Enum
unspecified
smaller ค้นหาข้อความที่มีขนาดเล็กกว่าที่ระบุ
larger ค้นหาข้อความที่มีขนาดใหญ่กว่าที่ระบุ

การดำเนินการ

ชุดการดำเนินการกับข้อความ

การแสดง JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
ช่อง
addLabelIds[]

string

รายการป้ายกำกับที่จะเพิ่มลงในข้อความ
removeLabelIds[]

string

รายการป้ายกำกับที่จะนำออกจากข้อความ
forward

string

อีเมลที่ควรส่งต่อข้อความไป

เมธอด

create

 สร้างตัวกรอง

delete

 ลบตัวกรองที่ระบุอย่างถาวรทันที

get

 รับตัวกรอง

list

 แสดงรายการตัวกรองข้อความของผู้ใช้ Gmail