1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.filters.html">filters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(userId, body)</a></code></p>
<p class="firstline">Creates a filter.</p>
<p class="toc_element">
<code><a href="#delete">delete(userId, id)</a></code></p>
<p class="firstline">Deletes a filter.</p>
<p class="toc_element">
<code><a href="#get">get(userId, id)</a></code></p>
<p class="firstline">Gets a filter.</p>
<p class="toc_element">
<code><a href="#list">list(userId)</a></code></p>
<p class="firstline">Lists the message filters of a Gmail user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(userId, body)</code>
<pre>Creates a filter.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
"action": { # A set of actions to perform on a message. # Action that the filter performs.
"forward": "A String", # Email address that the message should be forwarded to.
"removeLabelIds": [ # List of labels to remove from the message.
"A String",
],
"addLabelIds": [ # List of labels to add to the message.
"A String",
],
},
"id": "A String", # The server assigned ID of the filter.
"criteria": { # Message matching criteria. # Matching criteria for the filter.
"from": "A String", # The sender's display name or email address.
"hasAttachment": True or False, # Whether the message has any attachment.
"subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
"sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
"to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
"query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"excludeChats": True or False, # Whether the response should exclude chats.
"negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
},
}
Returns:
An object of the form:
{ # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
"action": { # A set of actions to perform on a message. # Action that the filter performs.
"forward": "A String", # Email address that the message should be forwarded to.
"removeLabelIds": [ # List of labels to remove from the message.
"A String",
],
"addLabelIds": [ # List of labels to add to the message.
"A String",
],
},
"id": "A String", # The server assigned ID of the filter.
"criteria": { # Message matching criteria. # Matching criteria for the filter.
"from": "A String", # The sender's display name or email address.
"hasAttachment": True or False, # Whether the message has any attachment.
"subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
"sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
"to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
"query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"excludeChats": True or False, # Whether the response should exclude chats.
"negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(userId, id)</code>
<pre>Deletes a filter.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
id: string, The ID of the filter to be deleted. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(userId, id)</code>
<pre>Gets a filter.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
id: string, The ID of the filter to be fetched. (required)
Returns:
An object of the form:
{ # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
"action": { # A set of actions to perform on a message. # Action that the filter performs.
"forward": "A String", # Email address that the message should be forwarded to.
"removeLabelIds": [ # List of labels to remove from the message.
"A String",
],
"addLabelIds": [ # List of labels to add to the message.
"A String",
],
},
"id": "A String", # The server assigned ID of the filter.
"criteria": { # Message matching criteria. # Matching criteria for the filter.
"from": "A String", # The sender's display name or email address.
"hasAttachment": True or False, # Whether the message has any attachment.
"subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
"sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
"to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
"query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"excludeChats": True or False, # Whether the response should exclude chats.
"negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(userId)</code>
<pre>Lists the message filters of a Gmail user.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Returns:
An object of the form:
{ # Response for the ListFilters method.
"filter": [ # List of a user's filters.
{ # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
"action": { # A set of actions to perform on a message. # Action that the filter performs.
"forward": "A String", # Email address that the message should be forwarded to.
"removeLabelIds": [ # List of labels to remove from the message.
"A String",
],
"addLabelIds": [ # List of labels to add to the message.
"A String",
],
},
"id": "A String", # The server assigned ID of the filter.
"criteria": { # Message matching criteria. # Matching criteria for the filter.
"from": "A String", # The sender's display name or email address.
"hasAttachment": True or False, # Whether the message has any attachment.
"subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
"sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
"to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
"query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"excludeChats": True or False, # Whether the response should exclude chats.
"negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
"size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
},
},
],
}</pre>
</div>
</body></html>
|
