Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / gmail_v1.users.settings.sendAs.html
blob: 196d4873c972c5c9a33499ba0a677ad2ef8e0b60 [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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83 <code><a href="#create">create(userId, body)</a></code></p>
84<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.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(userId, sendAsEmail)</a></code></p>
87<p class="firstline">Deletes the specified send-as alias. Revokes any verification that may have been required for using it.</p>
88<p class="toc_element">
89 <code><a href="#get">get(userId, sendAsEmail)</a></code></p>
90<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>
91<p class="toc_element">
92 <code><a href="#list">list(userId)</a></code></p>
93<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>
94<p class="toc_element">
95 <code><a href="#patch">patch(userId, sendAsEmail, body)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]96<p class="firstline">Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="toc_element">
98 <code><a href="#update">update(userId, sendAsEmail, body)</a></code></p>
99<p class="firstline">Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.</p>
100<p class="toc_element">
101 <code><a href="#verify">verify(userId, sendAsEmail)</a></code></p>
102<p class="firstline">Sends a verification email to the specified send-as alias address. The verification status must be pending.</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="create">create(userId, body)</code>
106 <pre>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.
107
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]108This method is only available to service account clients that have been delegated domain-wide authority.
109
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]110Args:
111 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]115{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
117 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
118 "username": "A String", # 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.
119 "host": "A String", # The hostname of the SMTP service. Required.
120 "password": "A String", # 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.
121 "port": 42, # The port of the SMTP service. Required.
122 },
123 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
124 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
125 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]126 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]127 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
128 "isPrimary": 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.
129 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
130 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
131}
132
133
134Returns:
135 An object of the form:
136
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]137 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]138 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
139 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
140 "username": "A String", # 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.
141 "host": "A String", # The hostname of the SMTP service. Required.
142 "password": "A String", # 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.
143 "port": 42, # The port of the SMTP service. Required.
144 },
145 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
146 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
147 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]148 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]149 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
150 "isPrimary": 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.
151 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
152 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="delete">delete(userId, sendAsEmail)</code>
158 <pre>Deletes the specified send-as alias. Revokes any verification that may have been required for using it.
159
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]160This method is only available to service account clients that have been delegated domain-wide authority.
161
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]162Args:
163 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
164 sendAsEmail: string, The send-as alias to be deleted. (required)
165</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="get">get(userId, sendAsEmail)</code>
170 <pre>Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.
171
172Args:
173 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
174 sendAsEmail: string, The send-as alias to be retrieved. (required)
175
176Returns:
177 An object of the form:
178
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]179 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]180 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
181 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
182 "username": "A String", # 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.
183 "host": "A String", # The hostname of the SMTP service. Required.
184 "password": "A String", # 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.
185 "port": 42, # The port of the SMTP service. Required.
186 },
187 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
188 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
189 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]190 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]191 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
192 "isPrimary": 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.
193 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
194 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="list">list(userId)</code>
200 <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 "from" aliases.
201
202Args:
203 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
204
205Returns:
206 An object of the form:
207
208 { # Response for the ListSendAs method.
209 "sendAs": [ # List of send-as aliases.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]210 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]211 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
212 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
213 "username": "A String", # 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.
214 "host": "A String", # The hostname of the SMTP service. Required.
215 "password": "A String", # 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.
216 "port": 42, # The port of the SMTP service. Required.
217 },
218 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
219 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
220 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]221 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]222 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
223 "isPrimary": 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.
224 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as 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 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.
226 },
227 ],
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="patch">patch(userId, sendAsEmail, body)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]233 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.
234
235Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]236
237Args:
238 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
239 sendAsEmail: string, The send-as alias to be updated. (required)
240 body: object, The request body. (required)
241 The object takes the form of:
242
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]243{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]244 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
245 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
246 "username": "A String", # 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.
247 "host": "A String", # The hostname of the SMTP service. Required.
248 "password": "A String", # 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.
249 "port": 42, # The port of the SMTP service. Required.
250 },
251 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
252 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
253 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]254 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]255 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
256 "isPrimary": 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.
257 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
258 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
259}
260
261
262Returns:
263 An object of the form:
264
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]265 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]266 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
267 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
268 "username": "A String", # 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 "host": "A String", # The hostname of the SMTP service. Required.
270 "password": "A String", # 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.
271 "port": 42, # The port of the SMTP service. Required.
272 },
273 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
274 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
275 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]276 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]277 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
278 "isPrimary": 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.
279 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
280 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="update">update(userId, sendAsEmail, body)</code>
286 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.
287
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]288Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.
289
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]290Args:
291 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
292 sendAsEmail: string, The send-as alias to be updated. (required)
293 body: object, The request body. (required)
294 The object takes the form of:
295
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]296{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]297 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
298 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
299 "username": "A String", # 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.
300 "host": "A String", # The hostname of the SMTP service. Required.
301 "password": "A String", # 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.
302 "port": 42, # The port of the SMTP service. Required.
303 },
304 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
305 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
306 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]307 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]308 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
309 "isPrimary": 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.
310 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
311 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
312}
313
314
315Returns:
316 An object of the form:
317
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]318 { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]319 "smtpMsa": { # 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's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
320 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
321 "username": "A String", # 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.
322 "host": "A String", # The hostname of the SMTP service. Required.
323 "password": "A String", # 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.
324 "port": 42, # The port of the SMTP service. Required.
325 },
326 "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
327 "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
328 "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]329 "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]330 "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
331 "isPrimary": 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.
332 "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
333 "isDefault": True or False, # Whether this address is selected as the default "From:" 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.
334 }</pre>
335</div>
336
337<div class="method">
338 <code class="details" id="verify">verify(userId, sendAsEmail)</code>
339 <pre>Sends a verification email to the specified send-as alias address. The verification status must be pending.
340
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]341This method is only available to service account clients that have been delegated domain-wide authority.
342
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]343Args:
344 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
345 sendAsEmail: string, The send-as alias to be verified. (required)
346</pre>
347</div>
348
349</body></html>