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)
  }
}
Trường
id

string

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

object (Criteria)

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

object (Action)

Thao tác 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)
}
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ỉ sử dụng phần địa chỉ 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

Phát hiện cụm từ không phân biệt chữ hoa chữ thường trong tiêu đề thư. Khoảng trắng ở đầu và cuối sẽ bị cắt bỏ và các khoảng trắng liền kề sẽ bị thu gọn.
query

string

Chỉ trả về những thư khớp với cụm từ tìm kiếm được chỉ định. Hỗ trợ định dạng truy vấn giống 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ư không khớp với cụm từ tìm kiếm được chỉ định. Hỗ trợ định dạng truy vấn giống 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 hay không.
excludeChats

boolean

Liệu nội dung phản hồi có loại trừ 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 cả 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ới 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ông báo.

Enum
unspecified
smaller Tìm thư có kích thước 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
}
Trường
addLabelIds[]

string

Danh sách nhãn cầ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 đã chỉ định.

get

 Lấy một bộ lọc.

list

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