资源:Filter
Gmail 过滤器的资源定义。过滤器应用于特定邮件,而非整个电子邮件会话。
JSON 表示法 |
---|
{ "id": string, "criteria": { object ( |
字段 | |
---|---|
id |
由服务器分配的过滤器 ID。 |
criteria |
过滤器的匹配条件。 |
action |
过滤器执行的操作。 |
条件
消息匹配条件。
JSON 表示法 |
---|
{
"from": string,
"to": string,
"subject": string,
"query": string,
"negatedQuery": string,
"hasAttachment": boolean,
"excludeChats": boolean,
"size": integer,
"sizeComparison": enum ( |
字段 | |
---|---|
from |
发件人的显示名称或电子邮件地址。 |
to |
收件人的显示名称或电子邮件地址。包括“收件人”“抄送”和“密送”标头字段中的收件人。您可以只使用电子邮件地址的本地部分。例如,“example”和“example@”均与“example@gmail.com”匹配。此字段不区分大小写。 |
subject |
在邮件的主题中发现不区分大小写的词组。结尾和前导空格会被删除,相邻空格会被收起。 |
query |
仅返回与指定查询匹配的邮件。支持与 Gmail 搜索框相同的查询格式。例如 |
negatedQuery |
仅返回与指定查询不匹配的邮件。支持与 Gmail 搜索框相同的查询格式。例如 |
hasAttachment |
消息是否包含任何附件。 |
excludeChats |
响应是否应排除聊天。 |
size |
整个 RFC822 邮件的大小(以字节为单位),包括所有标头和附件。 |
sizeComparison |
消息大小(以字节为单位)与大小字段的关系。 |
SizeComparison
确定如何将大小字段与消息大小进行比较。
枚举 | |
---|---|
unspecified |
|
smaller |
查找小于指定大小的邮件。 |
larger |
查找大于指定大小的邮件。 |
操作
对邮件执行的一组操作。
JSON 表示法 |
---|
{ "addLabelIds": [ string ], "removeLabelIds": [ string ], "forward": string } |
字段 | |
---|---|
addLabelIds[] |
要添加到邮件的标签列表。 |
removeLabelIds[] |
要从邮件中移除的标签列表。 |
forward |
应将邮件转发到的电子邮件地址。 |
方法 |
|
---|---|
|
创建过滤器。 |
|
立即永久删除指定的过滤器。 |
|
获取过滤器。 |
|
列出 Gmail 用户的邮件过滤器。 |