Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / gmail_v1.users.settings.sendAs.html
blob: b7962c322fce0e338e9457048840219f44c24667 [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> . <a href="gmail_v1.users.settings.sendAs.html">sendAs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="gmail_v1.users.settings.sendAs.smimeInfo.html">smimeInfo()</a></code>
79</p>
80<p class="firstline">Returns the smimeInfo Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]86 <code><a href="#delete">delete(userId, sendAsEmail, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified send-as alias. Revokes any verification that may</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]89 <code><a href="#get">get(userId, sendAsEmail, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets the specified send-as alias. Fails with an HTTP 404 error if the</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]91<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
93<p class="firstline">Lists the send-as aliases for the specified account. The result includes</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]95 <code><a href="#patch">patch(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Patch the specified send-as alias.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code><a href="#update">update(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates a send-as alias. If a signature is provided, Gmail will sanitize</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 <code><a href="#verify">verify(userId, sendAsEmail, x__xgafv=None)</a></code></p>
102<p class="firstline">Sends a verification email to the specified send-as alias address.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]103<h3>Method Details</h3>
104<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
106 <pre>Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail
107will attempt to connect to the SMTP service to validate the configuration
108before creating the alias. If ownership verification is required for the
109alias, a message will be sent to the email address and the resource's
110verification status will be set to &lt;code&gt;pending&lt;/code&gt;; otherwise, the
111resource will be created with verification status set to
112&lt;code&gt;accepted&lt;/code&gt;. If a signature is provided, Gmail will sanitize the
113HTML before saving it with the alias.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]114
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115This method is only available to service account clients that have been
116delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]117
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]118Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119 userId: string, User's email address. The special value "me"
120can be used to indicate the authenticated user. (required)
121 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]122 The object takes the form of:
123
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124{ # Settings associated with a send-as alias, which can be either the primary
125 # login address associated with the account or a custom "from" address.
126 # Send-as aliases correspond to the
127 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
128 # feature in the web interface.
129 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
130 # sent using this alias. If this is empty, outbound mail will be sent
131 # directly from Gmail's servers to the destination SMTP service. This
132 # setting only applies to custom "from" aliases.
133 "username": "A String", # The username that will be used for authentication with the SMTP service.
134 # This is a write-only field that can be specified in requests to create or
135 # update SendAs settings; it is never populated in responses.
136 "host": "A String", # The hostname of the SMTP service. Required.
137 "password": "A String", # The password that will be used for authentication with the SMTP service.
138 # This is a write-only field that can be specified in requests to create or
139 # update SendAs settings; it is never populated in responses.
140 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
141 # service. Required.
142 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]143 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
145 # For custom "from" addresses, when this is empty, Gmail will populate the
146 # "From:" header with the name that is used for the primary address
147 # associated with the account.
148 # If the admin has disabled the ability for users to update their name
149 # format, requests to update this field for the primary login will silently
150 # fail.
151 "signature": "A String", # An optional HTML signature that is included in messages composed with this
152 # alias in the Gmail web UI.
153 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
154 # sent using this alias. If this is empty, Gmail will not generate a
155 # "Reply-To:" header.
156 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
157 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
158 # This setting only applies to custom "from" aliases.
159 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
160 # this alias. This is read-only for all operations except create.
161 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
162 # Every Gmail account has exactly one primary address, and it cannot be
163 # deleted from the collection of send-as aliases. This field is read-only.
164 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
165 # alias. Read-only. This setting only applies to custom "from" aliases.
166 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
167 # situations such as composing a new message or sending a vacation
168 # auto-reply. Every Gmail account has exactly one default send-as address,
169 # so the only legal value that clients may write to this field is
170 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
171 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
172 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]173}
174
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179
180Returns:
181 An object of the form:
182
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 { # Settings associated with a send-as alias, which can be either the primary
184 # login address associated with the account or a custom "from" address.
185 # Send-as aliases correspond to the
186 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
187 # feature in the web interface.
188 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
189 # sent using this alias. If this is empty, outbound mail will be sent
190 # directly from Gmail's servers to the destination SMTP service. This
191 # setting only applies to custom "from" aliases.
192 "username": "A String", # The username that will be used for authentication with the SMTP service.
193 # This is a write-only field that can be specified in requests to create or
194 # update SendAs settings; it is never populated in responses.
195 "host": "A String", # The hostname of the SMTP service. Required.
196 "password": "A String", # The password that will be used for authentication with the SMTP service.
197 # This is a write-only field that can be specified in requests to create or
198 # update SendAs settings; it is never populated in responses.
199 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
200 # service. Required.
201 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]202 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]203 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
204 # For custom "from" addresses, when this is empty, Gmail will populate the
205 # "From:" header with the name that is used for the primary address
206 # associated with the account.
207 # If the admin has disabled the ability for users to update their name
208 # format, requests to update this field for the primary login will silently
209 # fail.
210 "signature": "A String", # An optional HTML signature that is included in messages composed with this
211 # alias in the Gmail web UI.
212 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
213 # sent using this alias. If this is empty, Gmail will not generate a
214 # "Reply-To:" header.
215 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
216 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
217 # This setting only applies to custom "from" aliases.
218 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
219 # this alias. This is read-only for all operations except create.
220 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
221 # Every Gmail account has exactly one primary address, and it cannot be
222 # deleted from the collection of send-as aliases. This field is read-only.
223 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
224 # alias. Read-only. This setting only applies to custom "from" aliases.
225 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
226 # situations such as composing a new message or sending a vacation
227 # auto-reply. Every Gmail account has exactly one default send-as address,
228 # so the only legal value that clients may write to this field is
229 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
230 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
231 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 <code class="details" id="delete">delete(userId, sendAsEmail, x__xgafv=None)</code>
237 <pre>Deletes the specified send-as alias. Revokes any verification that may
238have been required for using it.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]239
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240This method is only available to service account clients that have been
241delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]242
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]243Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]244 userId: string, User's email address. The special value "me"
245can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]246 sendAsEmail: string, The send-as alias to be deleted. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]251</pre>
252</div>
253
254<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]255 <code class="details" id="get">get(userId, sendAsEmail, x__xgafv=None)</code>
256 <pre>Gets the specified send-as alias. Fails with an HTTP 404 error if the
257specified address is not a member of the collection.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]258
259Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 userId: string, User's email address. The special value "me"
261can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]262 sendAsEmail: string, The send-as alias to be retrieved. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]267
268Returns:
269 An object of the form:
270
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]271 { # Settings associated with a send-as alias, which can be either the primary
272 # login address associated with the account or a custom "from" address.
273 # Send-as aliases correspond to the
274 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
275 # feature in the web interface.
276 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
277 # sent using this alias. If this is empty, outbound mail will be sent
278 # directly from Gmail's servers to the destination SMTP service. This
279 # setting only applies to custom "from" aliases.
280 "username": "A String", # The username that will be used for authentication with the SMTP service.
281 # This is a write-only field that can be specified in requests to create or
282 # update SendAs settings; it is never populated in responses.
283 "host": "A String", # The hostname of the SMTP service. Required.
284 "password": "A String", # The password that will be used for authentication with the SMTP service.
285 # This is a write-only field that can be specified in requests to create or
286 # update SendAs settings; it is never populated in responses.
287 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
288 # service. Required.
289 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]290 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
292 # For custom "from" addresses, when this is empty, Gmail will populate the
293 # "From:" header with the name that is used for the primary address
294 # associated with the account.
295 # If the admin has disabled the ability for users to update their name
296 # format, requests to update this field for the primary login will silently
297 # fail.
298 "signature": "A String", # An optional HTML signature that is included in messages composed with this
299 # alias in the Gmail web UI.
300 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
301 # sent using this alias. If this is empty, Gmail will not generate a
302 # "Reply-To:" header.
303 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
304 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
305 # This setting only applies to custom "from" aliases.
306 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
307 # this alias. This is read-only for all operations except create.
308 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
309 # Every Gmail account has exactly one primary address, and it cannot be
310 # deleted from the collection of send-as aliases. This field is read-only.
311 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
312 # alias. Read-only. This setting only applies to custom "from" aliases.
313 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
314 # situations such as composing a new message or sending a vacation
315 # auto-reply. Every Gmail account has exactly one default send-as address,
316 # so the only legal value that clients may write to this field is
317 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
318 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
319 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]320 }</pre>
321</div>
322
323<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 <code class="details" id="list">list(userId, x__xgafv=None)</code>
325 <pre>Lists the send-as aliases for the specified account. The result includes
326the primary send-as address associated with the account as well as any
327custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]328
329Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 userId: string, User's email address. The special value "me"
331can be used to indicate the authenticated user. (required)
332 x__xgafv: string, V1 error format.
333 Allowed values
334 1 - v1 error format
335 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]336
337Returns:
338 An object of the form:
339
340 { # Response for the ListSendAs method.
341 "sendAs": [ # List of send-as aliases.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]342 { # Settings associated with a send-as alias, which can be either the primary
343 # login address associated with the account or a custom "from" address.
344 # Send-as aliases correspond to the
345 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
346 # feature in the web interface.
347 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
348 # sent using this alias. If this is empty, outbound mail will be sent
349 # directly from Gmail's servers to the destination SMTP service. This
350 # setting only applies to custom "from" aliases.
351 "username": "A String", # The username that will be used for authentication with the SMTP service.
352 # This is a write-only field that can be specified in requests to create or
353 # update SendAs settings; it is never populated in responses.
354 "host": "A String", # The hostname of the SMTP service. Required.
355 "password": "A String", # The password that will be used for authentication with the SMTP service.
356 # This is a write-only field that can be specified in requests to create or
357 # update SendAs settings; it is never populated in responses.
358 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
359 # service. Required.
360 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]361 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]362 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
363 # For custom "from" addresses, when this is empty, Gmail will populate the
364 # "From:" header with the name that is used for the primary address
365 # associated with the account.
366 # If the admin has disabled the ability for users to update their name
367 # format, requests to update this field for the primary login will silently
368 # fail.
369 "signature": "A String", # An optional HTML signature that is included in messages composed with this
370 # alias in the Gmail web UI.
371 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
372 # sent using this alias. If this is empty, Gmail will not generate a
373 # "Reply-To:" header.
374 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
375 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
376 # This setting only applies to custom "from" aliases.
377 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
378 # this alias. This is read-only for all operations except create.
379 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
380 # Every Gmail account has exactly one primary address, and it cannot be
381 # deleted from the collection of send-as aliases. This field is read-only.
382 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
383 # alias. Read-only. This setting only applies to custom "from" aliases.
384 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
385 # situations such as composing a new message or sending a vacation
386 # auto-reply. Every Gmail account has exactly one default send-as address,
387 # so the only legal value that clients may write to this field is
388 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
389 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
390 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]391 },
392 ],
393 }</pre>
394</div>
395
396<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]397 <code class="details" id="patch">patch(userId, sendAsEmail, body=None, x__xgafv=None)</code>
398 <pre>Patch the specified send-as alias.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]399
400Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 userId: string, User's email address. The special value "me"
402can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]403 sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]405 The object takes the form of:
406
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]407{ # Settings associated with a send-as alias, which can be either the primary
408 # login address associated with the account or a custom "from" address.
409 # Send-as aliases correspond to the
410 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
411 # feature in the web interface.
412 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
413 # sent using this alias. If this is empty, outbound mail will be sent
414 # directly from Gmail's servers to the destination SMTP service. This
415 # setting only applies to custom "from" aliases.
416 "username": "A String", # The username that will be used for authentication with the SMTP service.
417 # This is a write-only field that can be specified in requests to create or
418 # update SendAs settings; it is never populated in responses.
419 "host": "A String", # The hostname of the SMTP service. Required.
420 "password": "A String", # The password that will be used for authentication with the SMTP service.
421 # This is a write-only field that can be specified in requests to create or
422 # update SendAs settings; it is never populated in responses.
423 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
424 # service. Required.
425 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]426 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
428 # For custom "from" addresses, when this is empty, Gmail will populate the
429 # "From:" header with the name that is used for the primary address
430 # associated with the account.
431 # If the admin has disabled the ability for users to update their name
432 # format, requests to update this field for the primary login will silently
433 # fail.
434 "signature": "A String", # An optional HTML signature that is included in messages composed with this
435 # alias in the Gmail web UI.
436 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
437 # sent using this alias. If this is empty, Gmail will not generate a
438 # "Reply-To:" header.
439 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
440 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
441 # This setting only applies to custom "from" aliases.
442 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
443 # this alias. This is read-only for all operations except create.
444 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
445 # Every Gmail account has exactly one primary address, and it cannot be
446 # deleted from the collection of send-as aliases. This field is read-only.
447 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
448 # alias. Read-only. This setting only applies to custom "from" aliases.
449 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
450 # situations such as composing a new message or sending a vacation
451 # auto-reply. Every Gmail account has exactly one default send-as address,
452 # so the only legal value that clients may write to this field is
453 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
454 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
455 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]456}
457
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]458 x__xgafv: string, V1 error format.
459 Allowed values
460 1 - v1 error format
461 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]462
463Returns:
464 An object of the form:
465
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 { # Settings associated with a send-as alias, which can be either the primary
467 # login address associated with the account or a custom "from" address.
468 # Send-as aliases correspond to the
469 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
470 # feature in the web interface.
471 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
472 # sent using this alias. If this is empty, outbound mail will be sent
473 # directly from Gmail's servers to the destination SMTP service. This
474 # setting only applies to custom "from" aliases.
475 "username": "A String", # The username that will be used for authentication with the SMTP service.
476 # This is a write-only field that can be specified in requests to create or
477 # update SendAs settings; it is never populated in responses.
478 "host": "A String", # The hostname of the SMTP service. Required.
479 "password": "A String", # The password that will be used for authentication with the SMTP service.
480 # This is a write-only field that can be specified in requests to create or
481 # update SendAs settings; it is never populated in responses.
482 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
483 # service. Required.
484 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]485 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]486 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
487 # For custom "from" addresses, when this is empty, Gmail will populate the
488 # "From:" header with the name that is used for the primary address
489 # associated with the account.
490 # If the admin has disabled the ability for users to update their name
491 # format, requests to update this field for the primary login will silently
492 # fail.
493 "signature": "A String", # An optional HTML signature that is included in messages composed with this
494 # alias in the Gmail web UI.
495 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
496 # sent using this alias. If this is empty, Gmail will not generate a
497 # "Reply-To:" header.
498 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
499 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
500 # This setting only applies to custom "from" aliases.
501 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
502 # this alias. This is read-only for all operations except create.
503 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
504 # Every Gmail account has exactly one primary address, and it cannot be
505 # deleted from the collection of send-as aliases. This field is read-only.
506 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
507 # alias. Read-only. This setting only applies to custom "from" aliases.
508 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
509 # situations such as composing a new message or sending a vacation
510 # auto-reply. Every Gmail account has exactly one default send-as address,
511 # so the only legal value that clients may write to this field is
512 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
513 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
514 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]515 }</pre>
516</div>
517
518<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 <code class="details" id="update">update(userId, sendAsEmail, body=None, x__xgafv=None)</code>
520 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize
521the HTML before saving it with the alias.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]522
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]523Addresses other than the primary address for the account can only be
524updated by service account clients that have been delegated domain-wide
525authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]526
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]527Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]528 userId: string, User's email address. The special value "me"
529can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]530 sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]531 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]532 The object takes the form of:
533
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]534{ # Settings associated with a send-as alias, which can be either the primary
535 # login address associated with the account or a custom "from" address.
536 # Send-as aliases correspond to the
537 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
538 # feature in the web interface.
539 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
540 # sent using this alias. If this is empty, outbound mail will be sent
541 # directly from Gmail's servers to the destination SMTP service. This
542 # setting only applies to custom "from" aliases.
543 "username": "A String", # The username that will be used for authentication with the SMTP service.
544 # This is a write-only field that can be specified in requests to create or
545 # update SendAs settings; it is never populated in responses.
546 "host": "A String", # The hostname of the SMTP service. Required.
547 "password": "A String", # The password that will be used for authentication with the SMTP service.
548 # This is a write-only field that can be specified in requests to create or
549 # update SendAs settings; it is never populated in responses.
550 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
551 # service. Required.
552 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]553 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]554 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
555 # For custom "from" addresses, when this is empty, Gmail will populate the
556 # "From:" header with the name that is used for the primary address
557 # associated with the account.
558 # If the admin has disabled the ability for users to update their name
559 # format, requests to update this field for the primary login will silently
560 # fail.
561 "signature": "A String", # An optional HTML signature that is included in messages composed with this
562 # alias in the Gmail web UI.
563 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
564 # sent using this alias. If this is empty, Gmail will not generate a
565 # "Reply-To:" header.
566 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
567 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
568 # This setting only applies to custom "from" aliases.
569 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
570 # this alias. This is read-only for all operations except create.
571 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
572 # Every Gmail account has exactly one primary address, and it cannot be
573 # deleted from the collection of send-as aliases. This field is read-only.
574 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
575 # alias. Read-only. This setting only applies to custom "from" aliases.
576 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
577 # situations such as composing a new message or sending a vacation
578 # auto-reply. Every Gmail account has exactly one default send-as address,
579 # so the only legal value that clients may write to this field is
580 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
581 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
582 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]583}
584
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]585 x__xgafv: string, V1 error format.
586 Allowed values
587 1 - v1 error format
588 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]589
590Returns:
591 An object of the form:
592
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]593 { # Settings associated with a send-as alias, which can be either the primary
594 # login address associated with the account or a custom "from" address.
595 # Send-as aliases correspond to the
596 # &lt;a href="https://support.google.com/mail/answer/22370"&gt;"Send Mail As"&lt;/a&gt;
597 # feature in the web interface.
598 "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail
599 # sent using this alias. If this is empty, outbound mail will be sent
600 # directly from Gmail's servers to the destination SMTP service. This
601 # setting only applies to custom "from" aliases.
602 "username": "A String", # The username that will be used for authentication with the SMTP service.
603 # This is a write-only field that can be specified in requests to create or
604 # update SendAs settings; it is never populated in responses.
605 "host": "A String", # The hostname of the SMTP service. Required.
606 "password": "A String", # The password that will be used for authentication with the SMTP service.
607 # This is a write-only field that can be specified in requests to create or
608 # update SendAs settings; it is never populated in responses.
609 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP
610 # service. Required.
611 "port": 42, # The port of the SMTP service. Required.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]612 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]613 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias.
614 # For custom "from" addresses, when this is empty, Gmail will populate the
615 # "From:" header with the name that is used for the primary address
616 # associated with the account.
617 # If the admin has disabled the ability for users to update their name
618 # format, requests to update this field for the primary login will silently
619 # fail.
620 "signature": "A String", # An optional HTML signature that is included in messages composed with this
621 # alias in the Gmail web UI.
622 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail
623 # sent using this alias. If this is empty, Gmail will not generate a
624 # "Reply-To:" header.
625 "treatAsAlias": True or False, # Whether Gmail should &lt;a href="https://support.google.com/a/answer/1710338"&gt;
626 # treat this address as an alias&lt;/a&gt; for the user's primary email address.
627 # This setting only applies to custom "from" aliases.
628 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using
629 # this alias. This is read-only for all operations except create.
630 "isPrimary": True or False, # Whether this address is the primary address used to login to the account.
631 # Every Gmail account has exactly one primary address, and it cannot be
632 # deleted from the collection of send-as aliases. This field is read-only.
633 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as
634 # alias. Read-only. This setting only applies to custom "from" aliases.
635 "isDefault": True or False, # Whether this address is selected as the default "From:" address in
636 # situations such as composing a new message or sending a vacation
637 # auto-reply. Every Gmail account has exactly one default send-as address,
638 # so the only legal value that clients may write to this field is
639 # &lt;code&gt;true&lt;/code&gt;. Changing this from &lt;code&gt;false&lt;/code&gt; to
640 # &lt;code&gt;true&lt;/code&gt; for an address will result in this field becoming
641 # &lt;code&gt;false&lt;/code&gt; for the other previous default address.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]642 }</pre>
643</div>
644
645<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]646 <code class="details" id="verify">verify(userId, sendAsEmail, x__xgafv=None)</code>
647 <pre>Sends a verification email to the specified send-as alias address.
648The verification status must be &lt;code&gt;pending&lt;/code&gt;.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]649
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]650This method is only available to service account clients that have been
651delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]652
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]653Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]654 userId: string, User's email address. The special value "me"
655can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]656 sendAsEmail: string, The send-as alias to be verified. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]657 x__xgafv: string, V1 error format.
658 Allowed values
659 1 - v1 error format
660 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]661</pre>
662</div>
663
664</body></html>