REST Resource: users.settings.filters

Tài nguyên: Bộ lọc

Định nghĩa tài nguyên cho bộ lọc Gmail. Bộ lọc áp dụng cho các thư cụ thể thay vì toàn bộ chuỗi email.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Các trường
id

string

Mã nhận dạng được chỉ định cho máy chủ của bộ lọc.
criteria

object (Criteria)

Tiêu chí khớp cho bộ lọc.
action

object (Action)

Hành động mà bộ lọc thực hiện.

Tiêu chí

Tiêu chí so khớp tin nhắn.

Biểu diễn dưới dạng JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Các trường
from

string

Tên hiển thị hoặc địa chỉ email của người gửi.
to

string

Tên hiển thị hoặc địa chỉ email của người nhận. Bao gồm người nhận trong các trường tiêu đề "to", "cc" và "bcc". Bạn có thể chỉ cần sử dụng phần cục bộ của địa chỉ email. Ví dụ: "example" và "example@" đều khớp với "example@gmail.com". Trường này không phân biệt chữ hoa chữ thường.
subject

string

Tìm thấy cụm từ không phân biệt chữ hoa chữ thường trong chủ đề của thư. Khoảng trắng ở đầu và ở cuối được cắt bỏ và các khoảng trắng liền kề được thu gọn.
query

string

Chỉ trả về những thông điệp khớp với truy vấn được chỉ định. Hỗ trợ định dạng truy vấn tương tự như hộp tìm kiếm của Gmail. Ví dụ: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Chỉ trả về những thông điệp không khớp với truy vấn đã chỉ định. Hỗ trợ định dạng truy vấn tương tự như hộp tìm kiếm của Gmail. Ví dụ: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Liệu thư có tệp đính kèm nào không.
excludeChats

boolean

Liệu câu trả lời có nên loại trừ các cuộc trò chuyện hay không.
size

integer

Kích thước của toàn bộ thư RFC822 tính bằng byte, bao gồm tất cả tiêu đề và tệp đính kèm.
sizeComparison

enum (SizeComparison)

Mối quan hệ giữa kích thước thư tính bằng byte và trường kích thước.

SizeComparison

Xác định cách so sánh trường kích thước với kích thước thư.

Enum
unspecified
smaller Tìm thư nhỏ hơn kích thước đã cho.
larger Tìm thư lớn hơn kích thước đã cho.

Hành động

Một tập hợp các thao tác cần thực hiện đối với một thư.

Biểu diễn dưới dạng JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Các trường
addLabelIds[]

string

Danh sách nhãn để thêm vào thư.
removeLabelIds[]

string

Danh sách nhãn cần xoá khỏi thư.
forward

string

Địa chỉ email mà thư sẽ được chuyển tiếp đến.

Phương thức

create

 Tạo bộ lọc.

delete

 Xoá ngay lập tức và vĩnh viễn bộ lọc được chỉ định.

get

 Xem bộ lọc.

list

 Liệt kê các bộ lọc thư của người dùng Gmail.