blob: 3bbda8b60d1470f6b62fb0710c3feba94b610f49 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001<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 -040078 <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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070086 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070087<p class="firstline">Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070088<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070089 <code><a href="#delete">delete(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090<p class="firstline">Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070091<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070092 <code><a href="#get">get(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093<p class="firstline">Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070094<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070095 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096<p class="firstline">Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070097<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070098 <code><a href="#patch">patch(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Patch the specified send-as alias.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700100<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101 <code><a href="#update">update(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102<p class="firstline">Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700103<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700104 <code><a href="#verify">verify(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105<p class="firstline">Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700111
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112<div class="method">
113 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
114 <pre>Creates a custom &quot;from&quot; send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource&#x27;s verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400115
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700119 The object takes the form of:
120
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
122 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
123 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
124 &quot;port&quot;: 42, # The port of the SMTP service. Required.
125 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
126 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
127 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
128 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
129 },
130 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
131 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
132 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
133 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
134 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
135 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
136 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
137}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700138
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700143
144Returns:
145 An object of the form:
146
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
148 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
149 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
150 &quot;port&quot;: 42, # The port of the SMTP service. Required.
151 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
152 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
153 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
154 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
155 },
156 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
157 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
158 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
159 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
160 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
161 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
162 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
163 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700164</div>
165
166<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700167 <code class="details" id="delete">delete(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700168 <pre>Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400169
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700170Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700171 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700172 sendAsEmail: string, The send-as alias to be deleted. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700177</pre>
178</div>
179
180<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700181 <code class="details" id="get">get(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 <pre>Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700183
184Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700186 sendAsEmail: string, The send-as alias to be retrieved. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700191
192Returns:
193 An object of the form:
194
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700195 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
196 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
197 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
198 &quot;port&quot;: 42, # The port of the SMTP service. Required.
199 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
200 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
201 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
202 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
203 },
204 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
205 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
206 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
207 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
208 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
209 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
210 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
211 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700212</div>
213
214<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700215 <code class="details" id="list">list(userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700216 <pre>Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom &quot;from&quot; aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700217
218Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700224
225Returns:
226 An object of the form:
227
228 { # Response for the ListSendAs method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 &quot;sendAs&quot;: [ # List of send-as aliases.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700230 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
231 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
232 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
233 &quot;port&quot;: 42, # The port of the SMTP service. Required.
234 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
235 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
236 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
237 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700238 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
240 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
241 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
242 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
243 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
244 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
245 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
246 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700247 ],
248 }</pre>
249</div>
250
251<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700252 <code class="details" id="patch">patch(userId, sendAsEmail, body=None, x__xgafv=None)</code>
253 <pre>Patch the specified send-as alias.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700254
255Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700257 sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700258 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700259 The object takes the form of:
260
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
262 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
263 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
264 &quot;port&quot;: 42, # The port of the SMTP service. Required.
265 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
266 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
267 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
268 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
269 },
270 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
271 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
272 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
273 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
274 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
275 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
276 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
277}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700278
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700283
284Returns:
285 An object of the form:
286
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700287 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
288 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
289 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
290 &quot;port&quot;: 42, # The port of the SMTP service. Required.
291 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
292 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
293 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
294 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
295 },
296 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
297 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
298 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
299 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
300 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
301 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
302 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
303 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700304</div>
305
306<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700307 <code class="details" id="update">update(userId, sendAsEmail, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400309
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700310Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700312 sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700313 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700314 The object takes the form of:
315
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700316{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
317 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
318 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
319 &quot;port&quot;: 42, # The port of the SMTP service. Required.
320 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
321 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
322 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
323 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
324 },
325 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
326 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
327 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
328 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
329 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
330 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
331 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
332}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700333
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700338
339Returns:
340 An object of the form:
341
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700342 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom &quot;from&quot; address. Send-as aliases correspond to the &quot;Send Mail As&quot; feature in the web interface.
343 &quot;sendAsEmail&quot;: &quot;A String&quot;, # The email address that appears in the &quot;From:&quot; header for mail sent using this alias. This is read-only for all operations except create.
344 &quot;smtpMsa&quot;: { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail&#x27;s servers to the destination SMTP service. This setting only applies to custom &quot;from&quot; aliases.
345 &quot;port&quot;: 42, # The port of the SMTP service. Required.
346 &quot;host&quot;: &quot;A String&quot;, # The hostname of the SMTP service. Required.
347 &quot;password&quot;: &quot;A String&quot;, # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
348 &quot;securityMode&quot;: &quot;A String&quot;, # The protocol that will be used to secure communication with the SMTP service. Required.
349 &quot;username&quot;: &quot;A String&quot;, # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
350 },
351 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom &quot;from&quot; aliases.
352 &quot;signature&quot;: &quot;A String&quot;, # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
353 &quot;isPrimary&quot;: True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
354 &quot;displayName&quot;: &quot;A String&quot;, # A name that appears in the &quot;From:&quot; header for mail sent using this alias. For custom &quot;from&quot; addresses, when this is empty, Gmail will populate the &quot;From:&quot; header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
355 &quot;replyToAddress&quot;: &quot;A String&quot;, # An optional email address that is included in a &quot;Reply-To:&quot; header for mail sent using this alias. If this is empty, Gmail will not generate a &quot;Reply-To:&quot; header.
356 &quot;isDefault&quot;: True or False, # Whether this address is selected as the default &quot;From:&quot; address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
357 &quot;treatAsAlias&quot;: True or False, # Whether Gmail should treat this address as an alias for the user&#x27;s primary email address. This setting only applies to custom &quot;from&quot; aliases.
358 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700359</div>
360
361<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700362 <code class="details" id="verify">verify(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700363 <pre>Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400364
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700365Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700366 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700367 sendAsEmail: string, The send-as alias to be verified. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700368 x__xgafv: string, V1 error format.
369 Allowed values
370 1 - v1 error format
371 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700372</pre>
373</div>
374
375</body></html>