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.delegates.html">delegates()</a></code> 79</p> 80<p class="firstline">Returns the delegates Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="gmail_v1.users.settings.filters.html">filters()</a></code> 84</p> 85<p class="firstline">Returns the filters Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses()</a></code> 89</p> 90<p class="firstline">Returns the forwardingAddresses Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="gmail_v1.users.settings.sendAs.html">sendAs()</a></code> 94</p> 95<p class="firstline">Returns the sendAs Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="#close">close()</a></code></p> 99<p class="firstline">Close httplib2 connections.</p> 100<p class="toc_element"> 101 <code><a href="#getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</a></code></p> 102<p class="firstline">Gets the auto-forwarding setting for the specified account.</p> 103<p class="toc_element"> 104 <code><a href="#getImap">getImap(userId, x__xgafv=None)</a></code></p> 105<p class="firstline">Gets IMAP settings.</p> 106<p class="toc_element"> 107 <code><a href="#getLanguage">getLanguage(userId, x__xgafv=None)</a></code></p> 108<p class="firstline">Gets language settings.</p> 109<p class="toc_element"> 110 <code><a href="#getPop">getPop(userId, x__xgafv=None)</a></code></p> 111<p class="firstline">Gets POP settings.</p> 112<p class="toc_element"> 113 <code><a href="#getVacation">getVacation(userId, x__xgafv=None)</a></code></p> 114<p class="firstline">Gets vacation responder settings.</p> 115<p class="toc_element"> 116 <code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</a></code></p> 117<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> 118<p class="toc_element"> 119 <code><a href="#updateImap">updateImap(userId, body=None, x__xgafv=None)</a></code></p> 120<p class="firstline">Updates IMAP settings.</p> 121<p class="toc_element"> 122 <code><a href="#updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</a></code></p> 123<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> 124<p class="toc_element"> 125 <code><a href="#updatePop">updatePop(userId, body=None, x__xgafv=None)</a></code></p> 126<p class="firstline">Updates POP settings.</p> 127<p class="toc_element"> 128 <code><a href="#updateVacation">updateVacation(userId, body=None, x__xgafv=None)</a></code></p> 129<p class="firstline">Updates vacation responder settings.</p> 130<h3>Method Details</h3> 131<div class="method"> 132 <code class="details" id="close">close()</code> 133 <pre>Close httplib2 connections.</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</code> 138 <pre>Gets the auto-forwarding setting for the specified account. 139 140Args: 141 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # Auto-forwarding settings for an account. 151 "disposition": "A String", # The state that a message should be left in after it has been forwarded. 152 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. 153 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address. 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="getImap">getImap(userId, x__xgafv=None)</code> 159 <pre>Gets IMAP settings. 160 161Args: 162 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # IMAP settings for an account. 172 "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. 173 "enabled": True or False, # Whether IMAP is enabled for the account. 174 "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. 175 "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. 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="getLanguage">getLanguage(userId, x__xgafv=None)</code> 181 <pre>Gets language settings. 182 183Args: 184 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 185 x__xgafv: string, V1 error format. 186 Allowed values 187 1 - v1 error format 188 2 - v2 error format 189 190Returns: 191 An object of the form: 192 193 { # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. 194 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="getPop">getPop(userId, x__xgafv=None)</code> 200 <pre>Gets POP settings. 201 202Args: 203 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # POP settings for an account. 213 "accessWindow": "A String", # The range of messages which are accessible via POP. 214 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP. 215}</pre> 216</div> 217 218<div class="method"> 219 <code class="details" id="getVacation">getVacation(userId, x__xgafv=None)</code> 220 <pre>Gets vacation responder settings. 221 222Args: 223 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 224 x__xgafv: string, V1 error format. 225 Allowed values 226 1 - v1 error format 227 2 - v2 error format 228 229Returns: 230 An object of the form: 231 232 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 233 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages. 234 "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`. 235 "responseBodyHtml": "A String", # 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 "responseBodyPlainText": "A String", # 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 "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. 238 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. 239 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. 240 "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`. 241}</pre> 242</div> 243 244<div class="method"> 245 <code class="details" id="updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</code> 246 <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. 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. 251 The object takes the form of: 252 253{ # Auto-forwarding settings for an account. 254 "disposition": "A String", # The state that a message should be left in after it has been forwarded. 255 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. 256 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address. 257} 258 259 x__xgafv: string, V1 error format. 260 Allowed values 261 1 - v1 error format 262 2 - v2 error format 263 264Returns: 265 An object of the form: 266 267 { # Auto-forwarding settings for an account. 268 "disposition": "A String", # The state that a message should be left in after it has been forwarded. 269 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. 270 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address. 271}</pre> 272</div> 273 274<div class="method"> 275 <code class="details" id="updateImap">updateImap(userId, body=None, x__xgafv=None)</code> 276 <pre>Updates IMAP settings. 277 278Args: 279 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 280 body: object, The request body. 281 The object takes the form of: 282 283{ # IMAP settings for an account. 284 "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. 285 "enabled": True or False, # Whether IMAP is enabled for the account. 286 "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. 287 "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. 288} 289 290 x__xgafv: string, V1 error format. 291 Allowed values 292 1 - v1 error format 293 2 - v2 error format 294 295Returns: 296 An object of the form: 297 298 { # IMAP settings for an account. 299 "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. 300 "enabled": True or False, # Whether IMAP is enabled for the account. 301 "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. 302 "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. 303}</pre> 304</div> 305 306<div class="method"> 307 <code class="details" id="updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</code> 308 <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. 309 310Args: 311 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 312 body: object, The request body. 313 The object takes the form of: 314 315{ # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. 316 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). 317} 318 319 x__xgafv: string, V1 error format. 320 Allowed values 321 1 - v1 error format 322 2 - v2 error format 323 324Returns: 325 An object of the form: 326 327 { # Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. 328 "displayLanguage": "A String", # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). 329}</pre> 330</div> 331 332<div class="method"> 333 <code class="details" id="updatePop">updatePop(userId, body=None, x__xgafv=None)</code> 334 <pre>Updates POP settings. 335 336Args: 337 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 338 body: object, The request body. 339 The object takes the form of: 340 341{ # POP settings for an account. 342 "accessWindow": "A String", # The range of messages which are accessible via POP. 343 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP. 344} 345 346 x__xgafv: string, V1 error format. 347 Allowed values 348 1 - v1 error format 349 2 - v2 error format 350 351Returns: 352 An object of the form: 353 354 { # POP settings for an account. 355 "accessWindow": "A String", # The range of messages which are accessible via POP. 356 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP. 357}</pre> 358</div> 359 360<div class="method"> 361 <code class="details" id="updateVacation">updateVacation(userId, body=None, x__xgafv=None)</code> 362 <pre>Updates vacation responder settings. 363 364Args: 365 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 366 body: object, The request body. 367 The object takes the form of: 368 369{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 370 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages. 371 "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`. 372 "responseBodyHtml": "A String", # 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. 373 "responseBodyPlainText": "A String", # Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used. 374 "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. 375 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. 376 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. 377 "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`. 378} 379 380 x__xgafv: string, V1 error format. 381 Allowed values 382 1 - v1 error format 383 2 - v2 error format 384 385Returns: 386 An object of the form: 387 388 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 389 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages. 390 "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`. 391 "responseBodyHtml": "A String", # 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 "responseBodyPlainText": "A String", # 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 "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. 394 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. 395 "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. 396 "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`. 397}</pre> 398</div> 399 400</body></html>