blob: 4a657d2b24186dd1859ef70d8aca02d296b163f5 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001<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 -070078 <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 -070083 <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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <code><a href="#close">close()</a></code></p>
99<p class="firstline">Close httplib2 connections.</p>
100<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101 <code><a href="#getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700102<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>
103<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700104 <code><a href="#getImap">getImap(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700105<p class="firstline">Gets IMAP settings.</p>
106<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700107 <code><a href="#getLanguage">getLanguage(userId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108<p class="firstline">Gets language settings.</p>
109<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700110 <code><a href="#getPop">getPop(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700111<p class="firstline">Gets POP settings.</p>
112<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700113 <code><a href="#getVacation">getVacation(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700114<p class="firstline">Gets vacation responder settings.</p>
115<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700116 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117<p class="firstline">Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700118<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 <code><a href="#updateImap">updateImap(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700120<p class="firstline">Updates IMAP settings.</p>
121<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700122 <code><a href="#updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123<p class="firstline">Updates language settings. If 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.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700125 <code><a href="#updatePop">updatePop(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700126<p class="firstline">Updates POP settings.</p>
127<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700128 <code><a href="#updateVacation">updateVacation(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700129<p class="firstline">Updates vacation responder settings.</p>
130<h3>Method Details</h3>
131<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700132 <code class="details" id="close">close()</code>
133 <pre>Close httplib2 connections.</pre>
134</div>
135
136<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700137 <code class="details" id="getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700138 <pre>Gets the auto-forwarding setting for the specified account.
139
140Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700146
147Returns:
148 An object of the form:
149
150 { # Auto-forwarding settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
152 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
153 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
154}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700155</div>
156
157<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700158 <code class="details" id="getImap">getImap(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700159 <pre>Gets IMAP settings.
160
161Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700162 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700167
168Returns:
169 An object of the form:
170
171 { # IMAP settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800172 &quot;autoExpunge&quot;: 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.
173 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
174 &quot;expungeBehavior&quot;: &quot;A String&quot;, # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
175 &quot;maxFolderSize&quot;: 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.
176}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700177</div>
178
179<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700180 <code class="details" id="getLanguage">getLanguage(userId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181 <pre>Gets language settings.
182
183Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700184 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189
190Returns:
191 An object of the form:
192
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700193 { # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800194 &quot;displayLanguage&quot;: &quot;A String&quot;, # 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). The set of languages supported by Gmail evolves over time, so please refer to the &quot;Language&quot; 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 Not all Gmail clients can display the same set of languages. In the case that a user&#x27;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).
195}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700196</div>
197
198<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700199 <code class="details" id="getPop">getPop(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700200 <pre>Gets POP settings.
201
202Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700203 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700208
209Returns:
210 An object of the form:
211
212 { # POP settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800213 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
214 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
215}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700216</div>
217
218<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700219 <code class="details" id="getVacation">getVacation(userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700220 <pre>Gets vacation responder settings.
221
222Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700228
229Returns:
230 An object of the form:
231
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 { # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800233 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
234 &quot;endTime&quot;: &quot;A String&quot;, # 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`.
235 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
236 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
237 &quot;responseSubject&quot;: &quot;A String&quot;, # 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.
238 &quot;restrictToContacts&quot;: True or False, # Flag that determines whether responses are sent to recipients who are not in the user&#x27;s list of contacts.
239 &quot;restrictToDomain&quot;: True or False, # Flag that determines whether responses are sent to recipients who are outside of the user&#x27;s domain. This feature is only available for G Suite users.
240 &quot;startTime&quot;: &quot;A String&quot;, # 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`.
241}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700242</div>
243
244<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700245 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700246 <pre>Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400247
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700248Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700250 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700251 The object takes the form of:
252
253{ # Auto-forwarding settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800254 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
255 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
256 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
257}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700258
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700263
264Returns:
265 An object of the form:
266
267 { # Auto-forwarding settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800268 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
269 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
270 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
271}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700272</div>
273
274<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700275 <code class="details" id="updateImap">updateImap(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700276 <pre>Updates IMAP settings.
277
278Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700279 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700280 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700281 The object takes the form of:
282
283{ # IMAP settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &quot;autoExpunge&quot;: 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.
285 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
286 &quot;expungeBehavior&quot;: &quot;A String&quot;, # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
287 &quot;maxFolderSize&quot;: 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.
288}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700289
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700290 x__xgafv: string, V1 error format.
291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700294
295Returns:
296 An object of the form:
297
298 { # IMAP settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800299 &quot;autoExpunge&quot;: 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.
300 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
301 &quot;expungeBehavior&quot;: &quot;A String&quot;, # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
302 &quot;maxFolderSize&quot;: 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.
303}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700304</div>
305
306<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700307 <code class="details" id="updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308 <pre>Updates language settings. If 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700309
310Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700312 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 The object takes the form of:
314
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700315{ # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800316 &quot;displayLanguage&quot;: &quot;A String&quot;, # 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). The set of languages supported by Gmail evolves over time, so please refer to the &quot;Language&quot; 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 Not all Gmail clients can display the same set of languages. In the case that a user&#x27;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).
317}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700319 x__xgafv: string, V1 error format.
320 Allowed values
321 1 - v1 error format
322 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700323
324Returns:
325 An object of the form:
326
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700327 { # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800328 &quot;displayLanguage&quot;: &quot;A String&quot;, # 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). The set of languages supported by Gmail evolves over time, so please refer to the &quot;Language&quot; 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 Not all Gmail clients can display the same set of languages. In the case that a user&#x27;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).
329}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330</div>
331
332<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700333 <code class="details" id="updatePop">updatePop(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700334 <pre>Updates POP settings.
335
336Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700337 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700338 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700339 The object takes the form of:
340
341{ # POP settings for an account.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800342 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
343 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
344}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700345
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700346 x__xgafv: string, V1 error format.
347 Allowed values
348 1 - v1 error format
349 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700350
351Returns:
352 An object of the form:
353
354 { # POP settings for an account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800355 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
356 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
357}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700358</div>
359
360<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700361 <code class="details" id="updateVacation">updateVacation(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700362 <pre>Updates vacation responder settings.
363
364Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700365 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700366 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700367 The object takes the form of:
368
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700369{ # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800370 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
371 &quot;endTime&quot;: &quot;A String&quot;, # 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`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800372 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800373 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800374 &quot;responseSubject&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800375 &quot;restrictToContacts&quot;: True or False, # Flag that determines whether responses are sent to recipients who are not in the user&#x27;s list of contacts.
376 &quot;restrictToDomain&quot;: True or False, # Flag that determines whether responses are sent to recipients who are outside of the user&#x27;s domain. This feature is only available for G Suite users.
377 &quot;startTime&quot;: &quot;A String&quot;, # 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`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800378}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700379
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700380 x__xgafv: string, V1 error format.
381 Allowed values
382 1 - v1 error format
383 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700384
385Returns:
386 An object of the form:
387
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700388 { # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
390 &quot;endTime&quot;: &quot;A String&quot;, # 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`.
391 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
392 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
393 &quot;responseSubject&quot;: &quot;A String&quot;, # 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.
394 &quot;restrictToContacts&quot;: True or False, # Flag that determines whether responses are sent to recipients who are not in the user&#x27;s list of contacts.
395 &quot;restrictToDomain&quot;: True or False, # Flag that determines whether responses are sent to recipients who are outside of the user&#x27;s domain. This feature is only available for G Suite users.
396 &quot;startTime&quot;: &quot;A String&quot;, # 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`.
397}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700398</div>
399
400</body></html>