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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="gmail_v1.users.settings.filters.html">filters()</a></code>
</p>
<p class="firstline">Returns the filters Resource.</p>
<p class="toc_element">
<code><a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses()</a></code>
</p>
<p class="firstline">Returns the forwardingAddresses Resource.</p>
<p class="toc_element">
<code><a href="gmail_v1.users.settings.sendAs.html">sendAs()</a></code>
</p>
<p class="firstline">Returns the sendAs Resource.</p>
<p class="toc_element">
<code><a href="#getAutoForwarding">getAutoForwarding(userId)</a></code></p>
<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>
<p class="toc_element">
<code><a href="#getImap">getImap(userId)</a></code></p>
<p class="firstline">Gets IMAP settings.</p>
<p class="toc_element">
<code><a href="#getPop">getPop(userId)</a></code></p>
<p class="firstline">Gets POP settings.</p>
<p class="toc_element">
<code><a href="#getVacation">getVacation(userId)</a></code></p>
<p class="firstline">Gets vacation responder settings.</p>
<p class="toc_element">
<code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body)</a></code></p>
<p class="firstline">Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.</p>
<p class="toc_element">
<code><a href="#updateImap">updateImap(userId, body)</a></code></p>
<p class="firstline">Updates IMAP settings.</p>
<p class="toc_element">
<code><a href="#updatePop">updatePop(userId, body)</a></code></p>
<p class="firstline">Updates POP settings.</p>
<p class="toc_element">
<code><a href="#updateVacation">updateVacation(userId, body)</a></code></p>
<p class="firstline">Updates vacation responder settings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="getAutoForwarding">getAutoForwarding(userId)</code>
<pre>Gets the auto-forwarding setting for the specified account.
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:
{ # Auto-forwarding settings for an account.
"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
"disposition": "A String", # The state that a message should be left in after it has been forwarded.
}</pre>
</div>
<div class="method">
<code class="details" id="getImap">getImap(userId)</code>
<pre>Gets IMAP settings.
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:
{ # IMAP settings for an account.
"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
"enabled": True or False, # Whether IMAP is enabled for the account.
"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
}</pre>
</div>
<div class="method">
<code class="details" id="getPop">getPop(userId)</code>
<pre>Gets POP settings.
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:
{ # POP settings for an account.
"disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
"accessWindow": "A String", # The range of messages which are accessible via POP.
}</pre>
</div>
<div class="method">
<code class="details" id="getVacation">getVacation(userId)</code>
<pre>Gets vacation responder settings.
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:
{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See for more details.
"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
"responseBodyPlainText": "A String", # Response body in plain text format.
"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
"startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
"endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
}</pre>
</div>
<div class="method">
<code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body)</code>
<pre>Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
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:
{ # Auto-forwarding settings for an account.
"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
"disposition": "A String", # The state that a message should be left in after it has been forwarded.
}
Returns:
An object of the form:
{ # Auto-forwarding settings for an account.
"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
"disposition": "A String", # The state that a message should be left in after it has been forwarded.
}</pre>
</div>
<div class="method">
<code class="details" id="updateImap">updateImap(userId, body)</code>
<pre>Updates IMAP settings.
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:
{ # IMAP settings for an account.
"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
"enabled": True or False, # Whether IMAP is enabled for the account.
"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
}
Returns:
An object of the form:
{ # IMAP settings for an account.
"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
"enabled": True or False, # Whether IMAP is enabled for the account.
"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
}</pre>
</div>
<div class="method">
<code class="details" id="updatePop">updatePop(userId, body)</code>
<pre>Updates POP settings.
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:
{ # POP settings for an account.
"disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
"accessWindow": "A String", # The range of messages which are accessible via POP.
}
Returns:
An object of the form:
{ # POP settings for an account.
"disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
"accessWindow": "A String", # The range of messages which are accessible via POP.
}</pre>
</div>
<div class="method">
<code class="details" id="updateVacation">updateVacation(userId, body)</code>
<pre>Updates vacation responder settings.
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:
{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See for more details.
"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
"responseBodyPlainText": "A String", # Response body in plain text format.
"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
"startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
"endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
}
Returns:
An object of the form:
{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See for more details.
"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
"responseBodyPlainText": "A String", # Response body in plain text format.
"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
"startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
"endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
}</pre>
</div>
</body></html>
|
