Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / gmail_v1.users.settings.html
blob: 8c4cc2231a2b1edd116b556e8630fe07f415c719 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 <code><a href="#getAutoForwarding">getAutoForwarding(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 <code><a href="#getImap">getImap(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 <code><a href="#getLanguage">getLanguage(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 <code><a href="#getPop">getPop(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 <code><a href="#getVacation">getVacation(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body=None)</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>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 <code><a href="#updateImap">updateImap(userId, body=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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 <code><a href="#updateLanguage">updateLanguage(userId, body=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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 <code><a href="#updatePop">updatePop(userId, body=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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 <code><a href="#updateVacation">updateVacation(userId, body=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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 <code class="details" id="getAutoForwarding">getAutoForwarding(userId)</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]134
135Returns:
136 An object of the form:
137
138 { # Auto-forwarding settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
140 &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.
141 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]142 }</pre>
143</div>
144
145<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 <code class="details" id="getImap">getImap(userId)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]147 <pre>Gets IMAP settings.
148
149Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]151
152Returns:
153 An object of the form:
154
155 { # IMAP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &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.
157 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
158 &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.
159 &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.
160 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]161</div>
162
163<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 <code class="details" id="getLanguage">getLanguage(userId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 <pre>Gets language settings.
166
167Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169
170Returns:
171 An object of the form:
172
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 { # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
174 &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).
175 #
176 # 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
177 #
178 # 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).
179 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180</div>
181
182<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 <code class="details" id="getPop">getPop(userId)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]184 <pre>Gets POP settings.
185
186Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]188
189Returns:
190 An object of the form:
191
192 { # POP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
194 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]195 }</pre>
196</div>
197
198<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 <code class="details" id="getVacation">getVacation(userId)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]200 <pre>Gets vacation responder settings.
201
202Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]204
205Returns:
206 An object of the form:
207
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 { # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
209 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
210 &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.
211 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it.
212 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format.
213 &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.
214 &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.
215 &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.
216 &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.
217 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]218</div>
219
220<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body=None)</code>
222 <pre>Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]223
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]225
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]226Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 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 -0700[diff] [blame]228 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]229 The object takes the form of:
230
231{ # Auto-forwarding settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
233 &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.
234 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]235}
236
237
238Returns:
239 An object of the form:
240
241 { # Auto-forwarding settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;disposition&quot;: &quot;A String&quot;, # The state that a message should be left in after it has been forwarded.
243 &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.
244 &quot;enabled&quot;: True or False, # Whether all incoming mail is automatically forwarded to another address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]245 }</pre>
246</div>
247
248<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 <code class="details" id="updateImap">updateImap(userId, body=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]250 <pre>Updates IMAP settings.
251
252Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 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 -0700[diff] [blame]254 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]255 The object takes the form of:
256
257{ # IMAP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]258 &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.
259 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
260 &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.
261 &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.
262}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]263
264
265Returns:
266 An object of the form:
267
268 { # IMAP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &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.
270 &quot;enabled&quot;: True or False, # Whether IMAP is enabled for the account.
271 &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.
272 &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.
273 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]274</div>
275
276<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]277 <code class="details" id="updateLanguage">updateLanguage(userId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 <pre>Updates language settings.
279
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281
282Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 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 -0700[diff] [blame]284 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 The object takes the form of:
286
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287{ # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
288 &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).
289 #
290 # 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
291 #
292 # 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).
293}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294
295
296Returns:
297 An object of the form:
298
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]299 { # Language settings for an account. These settings correspond to the &quot;Language settings&quot; feature in the web interface.
300 &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).
301 #
302 # 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
303 #
304 # 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).
305 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306</div>
307
308<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 <code class="details" id="updatePop">updatePop(userId, body=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]310 <pre>Updates POP settings.
311
312Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313 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 -0700[diff] [blame]314 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]315 The object takes the form of:
316
317{ # POP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]318 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
319 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]320}
321
322
323Returns:
324 An object of the form:
325
326 { # POP settings for an account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327 &quot;accessWindow&quot;: &quot;A String&quot;, # The range of messages which are accessible via POP.
328 &quot;disposition&quot;: &quot;A String&quot;, # The action that will be executed on a message after it has been fetched via POP.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]329 }</pre>
330</div>
331
332<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 <code class="details" id="updateVacation">updateVacation(userId, body=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]334 <pre>Updates vacation responder settings.
335
336Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]337 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 -0700[diff] [blame]338 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]339 The object takes the form of:
340
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]341{ # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
342 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
343 &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.
344 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it.
345 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format.
346 &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.
347 &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.
348 &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.
349 &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.
350}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]351
352
353Returns:
354 An object of the form:
355
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]356 { # Vacation auto-reply settings for an account. These settings correspond to the &quot;Vacation responder&quot; feature in the web interface.
357 &quot;enableAutoReply&quot;: True or False, # Flag that controls whether Gmail automatically replies to messages.
358 &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.
359 &quot;responseBodyHtml&quot;: &quot;A String&quot;, # Response body in HTML format. Gmail will sanitize the HTML before storing it.
360 &quot;responseBodyPlainText&quot;: &quot;A String&quot;, # Response body in plain text format.
361 &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.
362 &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.
363 &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.
364 &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.
365 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]366</div>
367
368</body></html>