Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / gmail_v1.users.settings.html
blob: 17e3a9123a01bf8748463fc179cab25d36c378aa [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="gmail_v1.users.settings.delegates.html">delegates()</a></code>
79</p>
80<p class="firstline">Returns the delegates Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83 <code><a href="gmail_v1.users.settings.filters.html">filters()</a></code>
84</p>
85<p class="firstline">Returns the filters Resource.</p>
86
87<p class="toc_element">
88 <code><a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses()</a></code>
89</p>
90<p class="firstline">Returns the forwardingAddresses Resource.</p>
91
92<p class="toc_element">
93 <code><a href="gmail_v1.users.settings.sendAs.html">sendAs()</a></code>
94</p>
95<p class="firstline">Returns the sendAs Resource.</p>
96
97<p class="toc_element">
98 <code><a href="#getAutoForwarding">getAutoForwarding(userId)</a></code></p>
99<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>
100<p class="toc_element">
101 <code><a href="#getImap">getImap(userId)</a></code></p>
102<p class="firstline">Gets IMAP settings.</p>
103<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]104 <code><a href="#getLanguage">getLanguage(userId)</a></code></p>
105<p class="firstline">Gets language settings.</p>
106<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107 <code><a href="#getPop">getPop(userId)</a></code></p>
108<p class="firstline">Gets POP settings.</p>
109<p class="toc_element">
110 <code><a href="#getVacation">getVacation(userId)</a></code></p>
111<p class="firstline">Gets vacation responder settings.</p>
112<p class="toc_element">
113 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body)</a></code></p>
114<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>
115<p class="toc_element">
116 <code><a href="#updateImap">updateImap(userId, body)</a></code></p>
117<p class="firstline">Updates IMAP settings.</p>
118<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]119 <code><a href="#updateLanguage">updateLanguage(userId, body)</a></code></p>
120<p class="firstline">Updates language settings.</p>
121<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]122 <code><a href="#updatePop">updatePop(userId, body)</a></code></p>
123<p class="firstline">Updates POP settings.</p>
124<p class="toc_element">
125 <code><a href="#updateVacation">updateVacation(userId, body)</a></code></p>
126<p class="firstline">Updates vacation responder settings.</p>
127<h3>Method Details</h3>
128<div class="method">
129 <code class="details" id="getAutoForwarding">getAutoForwarding(userId)</code>
130 <pre>Gets the auto-forwarding setting for the specified account.
131
132Args:
133 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
134
135Returns:
136 An object of the form:
137
138 { # Auto-forwarding settings for an account.
139 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
140 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
141 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="getImap">getImap(userId)</code>
147 <pre>Gets IMAP settings.
148
149Args:
150 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
151
152Returns:
153 An object of the form:
154
155 { # IMAP settings for an account.
156 "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.
157 "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.
158 "enabled": True or False, # Whether IMAP is enabled for the account.
159 "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.
160 }</pre>
161</div>
162
163<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]164 <code class="details" id="getLanguage">getLanguage(userId)</code>
165 <pre>Gets language settings.
166
167Args:
168 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
169
170Returns:
171 An object of the form:
172
173 { # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.
174 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).
175 #
176 # The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide
177 #
178 # Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).
179 }</pre>
180</div>
181
182<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]183 <code class="details" id="getPop">getPop(userId)</code>
184 <pre>Gets POP settings.
185
186Args:
187 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
188
189Returns:
190 An object of the form:
191
192 { # POP settings for an account.
193 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
194 "accessWindow": "A String", # The range of messages which are accessible via POP.
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="getVacation">getVacation(userId)</code>
200 <pre>Gets vacation responder settings.
201
202Args:
203 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
204
205Returns:
206 An object of the form:
207
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]208 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]209 "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.
210 "responseBodyPlainText": "A String", # Response body in plain text format.
211 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
212 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
213 "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.
214 "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.
215 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]216 "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 G Suite users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]217 }</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body)</code>
222 <pre>Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
223
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]224This method is only available to service account clients that have been delegated domain-wide authority.
225
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]226Args:
227 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
228 body: object, The request body. (required)
229 The object takes the form of:
230
231{ # Auto-forwarding settings for an account.
232 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
233 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
234 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
235}
236
237
238Returns:
239 An object of the form:
240
241 { # Auto-forwarding settings for an account.
242 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
243 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
244 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
245 }</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="updateImap">updateImap(userId, body)</code>
250 <pre>Updates IMAP settings.
251
252Args:
253 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
254 body: object, The request body. (required)
255 The object takes the form of:
256
257{ # IMAP settings for an account.
258 "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.
259 "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.
260 "enabled": True or False, # Whether IMAP is enabled for the account.
261 "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.
262 }
263
264
265Returns:
266 An object of the form:
267
268 { # IMAP settings for an account.
269 "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.
270 "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.
271 "enabled": True or False, # Whether IMAP is enabled for the account.
272 "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.
273 }</pre>
274</div>
275
276<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]277 <code class="details" id="updateLanguage">updateLanguage(userId, body)</code>
278 <pre>Updates language settings.
279
280If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.
281
282Args:
283 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
284 body: object, The request body. (required)
285 The object takes the form of:
286
287{ # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.
288 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).
289 #
290 # The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide
291 #
292 # Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).
293 }
294
295
296Returns:
297 An object of the form:
298
299 { # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.
300 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).
301 #
302 # The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide
303 #
304 # Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).
305 }</pre>
306</div>
307
308<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]309 <code class="details" id="updatePop">updatePop(userId, body)</code>
310 <pre>Updates POP settings.
311
312Args:
313 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
314 body: object, The request body. (required)
315 The object takes the form of:
316
317{ # POP settings for an account.
318 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
319 "accessWindow": "A String", # The range of messages which are accessible via POP.
320}
321
322
323Returns:
324 An object of the form:
325
326 { # POP settings for an account.
327 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
328 "accessWindow": "A String", # The range of messages which are accessible via POP.
329 }</pre>
330</div>
331
332<div class="method">
333 <code class="details" id="updateVacation">updateVacation(userId, body)</code>
334 <pre>Updates vacation responder settings.
335
336Args:
337 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
338 body: object, The request body. (required)
339 The object takes the form of:
340
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]341{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]342 "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.
343 "responseBodyPlainText": "A String", # Response body in plain text format.
344 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
345 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
346 "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.
347 "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.
348 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]349 "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 G Suite users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]350 }
351
352
353Returns:
354 An object of the form:
355
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]356 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]357 "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.
358 "responseBodyPlainText": "A String", # Response body in plain text format.
359 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
360 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
361 "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.
362 "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.
363 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]364 "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 G Suite users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]365 }</pre>
366</div>
367
368</body></html>