Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / gmail_v1.users.settings.html
blob: 372f33c4abb4f43cab814991e6fec9e1af9087eb [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code><a href="#getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>
100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 <code><a href="#getImap">getImap(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]102<p class="firstline">Gets IMAP settings.</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 <code><a href="#getLanguage">getLanguage(userId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105<p class="firstline">Gets language settings.</p>
106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 <code><a href="#getPop">getPop(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]108<p class="firstline">Gets POP settings.</p>
109<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 <code><a href="#getVacation">getVacation(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]111<p class="firstline">Gets vacation responder settings.</p>
112<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</a></code></p>
114<p class="firstline">Updates the auto-forwarding setting for the specified account. A verified</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 <code><a href="#updateImap">updateImap(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117<p class="firstline">Updates IMAP settings.</p>
118<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119 <code><a href="#updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120<p class="firstline">Updates language settings.</p>
121<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 <code><a href="#updatePop">updatePop(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123<p class="firstline">Updates POP settings.</p>
124<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 <code><a href="#updateVacation">updateVacation(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]126<p class="firstline">Updates vacation responder settings.</p>
127<h3>Method Details</h3>
128<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 <code class="details" id="getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]130 <pre>Gets the auto-forwarding setting for the specified account.
131
132Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 userId: string, User's email address. The special value "me"
134can be used to indicate the authenticated user. (required)
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]139
140Returns:
141 An object of the form:
142
143 { # Auto-forwarding settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email
145 # address must be a verified member of the forwarding addresses.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]146 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]147 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
148 }</pre>
149</div>
150
151<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 <code class="details" id="getImap">getImap(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]153 <pre>Gets IMAP settings.
154
155Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 userId: string, User's email address. The special value "me"
157can be used to indicate the authenticated user. (required)
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]162
163Returns:
164 An object of the form:
165
166 { # IMAP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may
168 # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero
169 # is interpreted to mean that there is no limit.
170 "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is
171 # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
172 # the client before expunging messages marked as deleted.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]173 "enabled": True or False, # Whether IMAP is enabled for the account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]174 "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted
175 # and expunged from the last visible IMAP folder.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 <code class="details" id="getLanguage">getLanguage(userId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 <pre>Gets language settings.
182
183Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 userId: string, User's email address. The special value "me"
185can be used to indicate the authenticated user. (required)
186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190
191Returns:
192 An object of the form:
193
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 { # Language settings for an account. These settings correspond to
195 # the &lt;a href="https://support.google.com/mail/answer/17091"&gt;"Language
196 # settings"&lt;/a&gt; feature in the web interface.
197 "displayLanguage": "A String", # The language to display Gmail in, formatted as an
198 # &lt;a href="https://www.w3.org/International/articles/language-tags/"&gt;RFC 3066
199 # Language Tag&lt;/a&gt; (for example &lt;code&gt;en-GB&lt;/code&gt;, &lt;code&gt;fr&lt;/code&gt; or
200 # &lt;code&gt;ja&lt;/code&gt; for British English, French, or Japanese respectively).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]202 # The set of languages supported by Gmail evolves over time, so please refer
203 # to the "Language" dropdown in the
204 # &lt;a href="https://mail.google.com/mail/u/0/#settings/general"&gt;Gmail settings
205 # &lt;/a&gt; for all available options, as described in the
206 # &lt;a href="https://support.google.com/mail/answer/17091"&gt;language settings
207 # help article&lt;/a&gt;. A table of sample values is also provided in the
208 # &lt;a href="/gmail/api/guides/language_settings#display_language"&gt;Managing
209 # Language Settings guide&lt;/a&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 # Not all Gmail clients can display the same set of languages. In the case
212 # that a user's display language is not available for use on a particular
213 # client, said client automatically chooses to display in the closest
214 # supported variant (or a reasonable default).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 }</pre>
216</div>
217
218<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 <code class="details" id="getPop">getPop(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]220 <pre>Gets POP settings.
221
222Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 userId: string, User's email address. The special value "me"
224can be used to indicate the authenticated user. (required)
225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]229
230Returns:
231 An object of the form:
232
233 { # POP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]234 "disposition": "A String", # The action that will be executed on a message after it has been fetched via
235 # POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]236 "accessWindow": "A String", # The range of messages which are accessible via POP.
237 }</pre>
238</div>
239
240<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 <code class="details" id="getVacation">getVacation(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]242 <pre>Gets vacation responder settings.
243
244Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]245 userId: string, User's email address. The special value "me"
246can be used to indicate the authenticated user. (required)
247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]251
252Returns:
253 An object of the form:
254
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]255 { # Vacation auto-reply settings for an account. These settings correspond to
256 # the &lt;a href="https://support.google.com/mail/answer/25922"&gt;"Vacation
257 # responder"&lt;/a&gt; feature in the web interface.
258 "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In
259 # order to enable auto-replies, either the response subject or the response
260 # body must be nonempty.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]261 "responseBodyPlainText": "A String", # Response body in plain text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not
263 # in the user's list of contacts.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]264 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]265 "startTime": "A String", # An optional start time for sending auto-replies (epoch ms).
266 # When this is specified, Gmail will automatically reply only to messages
267 # that it receives after the start time. If both &lt;code&gt;startTime&lt;/code&gt; and
268 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
269 # &lt;code&gt;endTime&lt;/code&gt;.
270 "endTime": "A String", # An optional end time for sending auto-replies (epoch ms).
271 # When this is specified, Gmail will automatically reply only to messages
272 # that it receives before the end time. If both &lt;code&gt;startTime&lt;/code&gt; and
273 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
274 # &lt;code&gt;endTime&lt;/code&gt;.
275 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before
276 # storing it.
277 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are
278 # outside of the user's domain. This feature is only available for G Suite
279 # users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]280 }</pre>
281</div>
282
283<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</code>
285 <pre>Updates the auto-forwarding setting for the specified account. A verified
286forwarding address must be specified when auto-forwarding is enabled.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]287
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]288This method is only available to service account clients that have been
289delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]290
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]291Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 userId: string, User's email address. The special value "me"
293can be used to indicate the authenticated user. (required)
294 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]295 The object takes the form of:
296
297{ # Auto-forwarding settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email
299 # address must be a verified member of the forwarding addresses.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]300 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]301 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
302}
303
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 x__xgafv: string, V1 error format.
305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]308
309Returns:
310 An object of the form:
311
312 { # Auto-forwarding settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]313 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email
314 # address must be a verified member of the forwarding addresses.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]315 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]316 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
317 }</pre>
318</div>
319
320<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 <code class="details" id="updateImap">updateImap(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]322 <pre>Updates IMAP settings.
323
324Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325 userId: string, User's email address. The special value "me"
326can be used to indicate the authenticated user. (required)
327 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]328 The object takes the form of:
329
330{ # IMAP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331 "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may
332 # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero
333 # is interpreted to mean that there is no limit.
334 "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is
335 # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
336 # the client before expunging messages marked as deleted.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]337 "enabled": True or False, # Whether IMAP is enabled for the account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted
339 # and expunged from the last visible IMAP folder.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]340 }
341
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]346
347Returns:
348 An object of the form:
349
350 { # IMAP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351 "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may
352 # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero
353 # is interpreted to mean that there is no limit.
354 "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is
355 # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
356 # the client before expunging messages marked as deleted.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]357 "enabled": True or False, # Whether IMAP is enabled for the account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted
359 # and expunged from the last visible IMAP folder.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]360 }</pre>
361</div>
362
363<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]364 <code class="details" id="updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 <pre>Updates language settings.
366
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367If successful, the return object contains the &lt;code&gt;displayLanguage&lt;/code&gt;
368that was saved for the user, which may differ from the value passed into
369the request. This is because the requested &lt;code&gt;displayLanguage&lt;/code&gt; may
370not be directly supported by Gmail but have a close variant that is, and so
371the variant may be chosen and saved instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372
373Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 userId: string, User's email address. The special value "me"
375can be used to indicate the authenticated user. (required)
376 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]377 The object takes the form of:
378
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379{ # Language settings for an account. These settings correspond to
380 # the &lt;a href="https://support.google.com/mail/answer/17091"&gt;"Language
381 # settings"&lt;/a&gt; feature in the web interface.
382 "displayLanguage": "A String", # The language to display Gmail in, formatted as an
383 # &lt;a href="https://www.w3.org/International/articles/language-tags/"&gt;RFC 3066
384 # Language Tag&lt;/a&gt; (for example &lt;code&gt;en-GB&lt;/code&gt;, &lt;code&gt;fr&lt;/code&gt; or
385 # &lt;code&gt;ja&lt;/code&gt; for British English, French, or Japanese respectively).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]387 # The set of languages supported by Gmail evolves over time, so please refer
388 # to the "Language" dropdown in the
389 # &lt;a href="https://mail.google.com/mail/u/0/#settings/general"&gt;Gmail settings
390 # &lt;/a&gt; for all available options, as described in the
391 # &lt;a href="https://support.google.com/mail/answer/17091"&gt;language settings
392 # help article&lt;/a&gt;. A table of sample values is also provided in the
393 # &lt;a href="/gmail/api/guides/language_settings#display_language"&gt;Managing
394 # Language Settings guide&lt;/a&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]396 # Not all Gmail clients can display the same set of languages. In the case
397 # that a user's display language is not available for use on a particular
398 # client, said client automatically chooses to display in the closest
399 # supported variant (or a reasonable default).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 }
401
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406
407Returns:
408 An object of the form:
409
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]410 { # Language settings for an account. These settings correspond to
411 # the &lt;a href="https://support.google.com/mail/answer/17091"&gt;"Language
412 # settings"&lt;/a&gt; feature in the web interface.
413 "displayLanguage": "A String", # The language to display Gmail in, formatted as an
414 # &lt;a href="https://www.w3.org/International/articles/language-tags/"&gt;RFC 3066
415 # Language Tag&lt;/a&gt; (for example &lt;code&gt;en-GB&lt;/code&gt;, &lt;code&gt;fr&lt;/code&gt; or
416 # &lt;code&gt;ja&lt;/code&gt; for British English, French, or Japanese respectively).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 # The set of languages supported by Gmail evolves over time, so please refer
419 # to the "Language" dropdown in the
420 # &lt;a href="https://mail.google.com/mail/u/0/#settings/general"&gt;Gmail settings
421 # &lt;/a&gt; for all available options, as described in the
422 # &lt;a href="https://support.google.com/mail/answer/17091"&gt;language settings
423 # help article&lt;/a&gt;. A table of sample values is also provided in the
424 # &lt;a href="/gmail/api/guides/language_settings#display_language"&gt;Managing
425 # Language Settings guide&lt;/a&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 # Not all Gmail clients can display the same set of languages. In the case
428 # that a user's display language is not available for use on a particular
429 # client, said client automatically chooses to display in the closest
430 # supported variant (or a reasonable default).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 }</pre>
432</div>
433
434<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]435 <code class="details" id="updatePop">updatePop(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]436 <pre>Updates POP settings.
437
438Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 userId: string, User's email address. The special value "me"
440can be used to indicate the authenticated user. (required)
441 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]442 The object takes the form of:
443
444{ # POP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 "disposition": "A String", # The action that will be executed on a message after it has been fetched via
446 # POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]447 "accessWindow": "A String", # The range of messages which are accessible via POP.
448}
449
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 x__xgafv: string, V1 error format.
451 Allowed values
452 1 - v1 error format
453 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]454
455Returns:
456 An object of the form:
457
458 { # POP settings for an account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]459 "disposition": "A String", # The action that will be executed on a message after it has been fetched via
460 # POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]461 "accessWindow": "A String", # The range of messages which are accessible via POP.
462 }</pre>
463</div>
464
465<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 <code class="details" id="updateVacation">updateVacation(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]467 <pre>Updates vacation responder settings.
468
469Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 userId: string, User's email address. The special value "me"
471can be used to indicate the authenticated user. (required)
472 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]473 The object takes the form of:
474
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]475{ # Vacation auto-reply settings for an account. These settings correspond to
476 # the &lt;a href="https://support.google.com/mail/answer/25922"&gt;"Vacation
477 # responder"&lt;/a&gt; feature in the web interface.
478 "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In
479 # order to enable auto-replies, either the response subject or the response
480 # body must be nonempty.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]481 "responseBodyPlainText": "A String", # Response body in plain text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not
483 # in the user's list of contacts.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]484 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]485 "startTime": "A String", # An optional start time for sending auto-replies (epoch ms).
486 # When this is specified, Gmail will automatically reply only to messages
487 # that it receives after the start time. If both &lt;code&gt;startTime&lt;/code&gt; and
488 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
489 # &lt;code&gt;endTime&lt;/code&gt;.
490 "endTime": "A String", # An optional end time for sending auto-replies (epoch ms).
491 # When this is specified, Gmail will automatically reply only to messages
492 # that it receives before the end time. If both &lt;code&gt;startTime&lt;/code&gt; and
493 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
494 # &lt;code&gt;endTime&lt;/code&gt;.
495 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before
496 # storing it.
497 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are
498 # outside of the user's domain. This feature is only available for G Suite
499 # users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]500 }
501
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]502 x__xgafv: string, V1 error format.
503 Allowed values
504 1 - v1 error format
505 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]506
507Returns:
508 An object of the form:
509
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]510 { # Vacation auto-reply settings for an account. These settings correspond to
511 # the &lt;a href="https://support.google.com/mail/answer/25922"&gt;"Vacation
512 # responder"&lt;/a&gt; feature in the web interface.
513 "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In
514 # order to enable auto-replies, either the response subject or the response
515 # body must be nonempty.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]516 "responseBodyPlainText": "A String", # Response body in plain text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not
518 # in the user's list of contacts.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]519 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]520 "startTime": "A String", # An optional start time for sending auto-replies (epoch ms).
521 # When this is specified, Gmail will automatically reply only to messages
522 # that it receives after the start time. If both &lt;code&gt;startTime&lt;/code&gt; and
523 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
524 # &lt;code&gt;endTime&lt;/code&gt;.
525 "endTime": "A String", # An optional end time for sending auto-replies (epoch ms).
526 # When this is specified, Gmail will automatically reply only to messages
527 # that it receives before the end time. If both &lt;code&gt;startTime&lt;/code&gt; and
528 # &lt;code&gt;endTime&lt;/code&gt; are specified, &lt;code&gt;startTime&lt;/code&gt; must precede
529 # &lt;code&gt;endTime&lt;/code&gt;.
530 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before
531 # storing it.
532 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are
533 # outside of the user's domain. This feature is only available for G Suite
534 # users.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]535 }</pre>
536</div>
537
538</body></html>