Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / gmail_v1.users.settings.html
blob: 9675a3545a9079f85b308607a17e42e4497bd42d [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">
78 <code><a href="gmail_v1.users.settings.filters.html">filters()</a></code>
79</p>
80<p class="firstline">Returns the filters Resource.</p>
81
82<p class="toc_element">
83 <code><a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses()</a></code>
84</p>
85<p class="firstline">Returns the forwardingAddresses Resource.</p>
86
87<p class="toc_element">
88 <code><a href="gmail_v1.users.settings.sendAs.html">sendAs()</a></code>
89</p>
90<p class="firstline">Returns the sendAs Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#getAutoForwarding">getAutoForwarding(userId)</a></code></p>
94<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>
95<p class="toc_element">
96 <code><a href="#getImap">getImap(userId)</a></code></p>
97<p class="firstline">Gets IMAP settings.</p>
98<p class="toc_element">
99 <code><a href="#getPop">getPop(userId)</a></code></p>
100<p class="firstline">Gets POP settings.</p>
101<p class="toc_element">
102 <code><a href="#getVacation">getVacation(userId)</a></code></p>
103<p class="firstline">Gets vacation responder settings.</p>
104<p class="toc_element">
105 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body)</a></code></p>
106<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>
107<p class="toc_element">
108 <code><a href="#updateImap">updateImap(userId, body)</a></code></p>
109<p class="firstline">Updates IMAP settings.</p>
110<p class="toc_element">
111 <code><a href="#updatePop">updatePop(userId, body)</a></code></p>
112<p class="firstline">Updates POP settings.</p>
113<p class="toc_element">
114 <code><a href="#updateVacation">updateVacation(userId, body)</a></code></p>
115<p class="firstline">Updates vacation responder settings.</p>
116<h3>Method Details</h3>
117<div class="method">
118 <code class="details" id="getAutoForwarding">getAutoForwarding(userId)</code>
119 <pre>Gets the auto-forwarding setting for the specified account.
120
121Args:
122 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
123
124Returns:
125 An object of the form:
126
127 { # Auto-forwarding settings for an account.
128 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
129 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
130 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="getImap">getImap(userId)</code>
136 <pre>Gets IMAP settings.
137
138Args:
139 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
140
141Returns:
142 An object of the form:
143
144 { # IMAP settings for an account.
145 "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.
146 "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.
147 "enabled": True or False, # Whether IMAP is enabled for the account.
148 "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.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="getPop">getPop(userId)</code>
154 <pre>Gets POP settings.
155
156Args:
157 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
158
159Returns:
160 An object of the form:
161
162 { # POP settings for an account.
163 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
164 "accessWindow": "A String", # The range of messages which are accessible via POP.
165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="getVacation">getVacation(userId)</code>
170 <pre>Gets vacation responder settings.
171
172Args:
173 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
174
175Returns:
176 An object of the form:
177
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]178 { # 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]179 "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.
180 "responseBodyPlainText": "A String", # Response body in plain text format.
181 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
182 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
183 "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.
184 "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.
185 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
186 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body)</code>
192 <pre>Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
193
194Args:
195 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
196 body: object, The request body. (required)
197 The object takes the form of:
198
199{ # Auto-forwarding settings for an account.
200 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
201 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
202 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
203}
204
205
206Returns:
207 An object of the form:
208
209 { # Auto-forwarding settings for an account.
210 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
211 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
212 "disposition": "A String", # The state that a message should be left in after it has been forwarded.
213 }</pre>
214</div>
215
216<div class="method">
217 <code class="details" id="updateImap">updateImap(userId, body)</code>
218 <pre>Updates IMAP settings.
219
220Args:
221 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
222 body: object, The request body. (required)
223 The object takes the form of:
224
225{ # IMAP settings for an account.
226 "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.
227 "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.
228 "enabled": True or False, # Whether IMAP is enabled for the account.
229 "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.
230 }
231
232
233Returns:
234 An object of the form:
235
236 { # IMAP settings for an account.
237 "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.
238 "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.
239 "enabled": True or False, # Whether IMAP is enabled for the account.
240 "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.
241 }</pre>
242</div>
243
244<div class="method">
245 <code class="details" id="updatePop">updatePop(userId, body)</code>
246 <pre>Updates POP settings.
247
248Args:
249 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
250 body: object, The request body. (required)
251 The object takes the form of:
252
253{ # POP settings for an account.
254 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
255 "accessWindow": "A String", # The range of messages which are accessible via POP.
256}
257
258
259Returns:
260 An object of the form:
261
262 { # POP settings for an account.
263 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
264 "accessWindow": "A String", # The range of messages which are accessible via POP.
265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="updateVacation">updateVacation(userId, body)</code>
270 <pre>Updates vacation responder settings.
271
272Args:
273 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
274 body: object, The request body. (required)
275 The object takes the form of:
276
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]277{ # 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]278 "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.
279 "responseBodyPlainText": "A String", # Response body in plain text format.
280 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
281 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
282 "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.
283 "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.
284 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
285 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
286 }
287
288
289Returns:
290 An object of the form:
291
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]292 { # 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]293 "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.
294 "responseBodyPlainText": "A String", # Response body in plain text format.
295 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
296 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
297 "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.
298 "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.
299 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
300 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
301 }</pre>
302</div>
303
304</body></html>