1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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 121 Args: 122 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 123 124 Returns: 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 138 Args: 139 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 140 141 Returns: 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 156 Args: 157 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 158 159 Returns: 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 172 Args: 173 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 174 175 Returns: 176 An object of the form: 177 178 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 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 G Suite 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 194 This method is only available to service account clients that have been delegated domain-wide authority. 195 196 Args: 197 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 198 body: object, The request body. (required) 199 The object takes the form of: 200 201 { # Auto-forwarding settings for an account. 202 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address. 203 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. 204 "disposition": "A String", # The state that a message should be left in after it has been forwarded. 205 } 206 207 208 Returns: 209 An object of the form: 210 211 { # Auto-forwarding settings for an account. 212 "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address. 213 "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. 214 "disposition": "A String", # The state that a message should be left in after it has been forwarded. 215 }</pre> 216 </div> 217 218 <div class="method"> 219 <code class="details" id="updateImap">updateImap(userId, body)</code> 220 <pre>Updates IMAP settings. 221 222 Args: 223 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 224 body: object, The request body. (required) 225 The object takes the form of: 226 227 { # IMAP settings for an account. 228 "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. 229 "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. 230 "enabled": True or False, # Whether IMAP is enabled for the account. 231 "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. 232 } 233 234 235 Returns: 236 An object of the form: 237 238 { # IMAP settings for an account. 239 "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. 240 "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. 241 "enabled": True or False, # Whether IMAP is enabled for the account. 242 "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. 243 }</pre> 244 </div> 245 246 <div class="method"> 247 <code class="details" id="updatePop">updatePop(userId, body)</code> 248 <pre>Updates POP settings. 249 250 Args: 251 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 252 body: object, The request body. (required) 253 The object takes the form of: 254 255 { # POP settings for an account. 256 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP. 257 "accessWindow": "A String", # The range of messages which are accessible via POP. 258 } 259 260 261 Returns: 262 An object of the form: 263 264 { # POP settings for an account. 265 "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP. 266 "accessWindow": "A String", # The range of messages which are accessible via POP. 267 }</pre> 268 </div> 269 270 <div class="method"> 271 <code class="details" id="updateVacation">updateVacation(userId, body)</code> 272 <pre>Updates vacation responder settings. 273 274 Args: 275 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 276 body: object, The request body. (required) 277 The object takes the form of: 278 279 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 280 "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. 281 "responseBodyPlainText": "A String", # Response body in plain text format. 282 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. 283 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages. 284 "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. 285 "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. 286 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it. 287 "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. 288 } 289 290 291 Returns: 292 An object of the form: 293 294 { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. 295 "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. 296 "responseBodyPlainText": "A String", # Response body in plain text format. 297 "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. 298 "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages. 299 "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. 300 "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. 301 "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it. 302 "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. 303 }</pre> 304 </div> 305 306 </body></html>
