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

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