Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / gmail_v1.users.settings.sendAs.html
blob: 6d0231ff7b79ea2a0fe2cd318501f456c2f232e6 [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">
78 <code><a href="#create">create(userId, body)</a></code></p>
79<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>
80<p class="toc_element">
81 <code><a href="#delete">delete(userId, sendAsEmail)</a></code></p>
82<p class="firstline">Deletes the specified send-as alias. Revokes any verification that may have been required for using it.</p>
83<p class="toc_element">
84 <code><a href="#get">get(userId, sendAsEmail)</a></code></p>
85<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>
86<p class="toc_element">
87 <code><a href="#list">list(userId)</a></code></p>
88<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>
89<p class="toc_element">
90 <code><a href="#patch">patch(userId, sendAsEmail, body)</a></code></p>
91<p class="firstline">Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(userId, sendAsEmail, body)</a></code></p>
94<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>
95<p class="toc_element">
96 <code><a href="#verify">verify(userId, sendAsEmail)</a></code></p>
97<p class="firstline">Sends a verification email to the specified send-as alias address. The verification status must be pending.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(userId, body)</code>
101 <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.
102
103Args:
104 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]108{ # 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]109 "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.
110 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
111 "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.
112 "host": "A String", # The hostname of the SMTP service. Required.
113 "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.
114 "port": 42, # The port of the SMTP service. Required.
115 },
116 "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.
117 "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.
118 "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^]119 "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]120 "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.
121 "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.
122 "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.
123 "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.
124}
125
126
127Returns:
128 An object of the form:
129
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]130 { # 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]131 "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.
132 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
133 "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.
134 "host": "A String", # The hostname of the SMTP service. Required.
135 "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.
136 "port": 42, # The port of the SMTP service. Required.
137 },
138 "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.
139 "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.
140 "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^]141 "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]142 "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.
143 "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.
144 "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.
145 "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.
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="delete">delete(userId, sendAsEmail)</code>
151 <pre>Deletes the specified send-as alias. Revokes any verification that may have been required for using it.
152
153Args:
154 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
155 sendAsEmail: string, The send-as alias to be deleted. (required)
156</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="get">get(userId, sendAsEmail)</code>
161 <pre>Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.
162
163Args:
164 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
165 sendAsEmail: string, The send-as alias to be retrieved. (required)
166
167Returns:
168 An object of the form:
169
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]170 { # 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]171 "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.
172 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
173 "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.
174 "host": "A String", # The hostname of the SMTP service. Required.
175 "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.
176 "port": 42, # The port of the SMTP service. Required.
177 },
178 "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.
179 "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.
180 "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^]181 "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]182 "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.
183 "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.
184 "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.
185 "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.
186 }</pre>
187</div>
188
189<div class="method">
190 <code class="details" id="list">list(userId)</code>
191 <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.
192
193Args:
194 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
195
196Returns:
197 An object of the form:
198
199 { # Response for the ListSendAs method.
200 "sendAs": [ # List of send-as aliases.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]201 { # 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]202 "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.
203 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
204 "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.
205 "host": "A String", # The hostname of the SMTP service. Required.
206 "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.
207 "port": 42, # The port of the SMTP service. Required.
208 },
209 "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.
210 "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.
211 "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^]212 "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]213 "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.
214 "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.
215 "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.
216 "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.
217 },
218 ],
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="patch">patch(userId, sendAsEmail, body)</code>
224 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.
225
226Args:
227 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
228 sendAsEmail: string, The send-as alias to be updated. (required)
229 body: object, The request body. (required)
230 The object takes the form of:
231
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]232{ # 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]233 "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.
234 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
235 "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.
236 "host": "A String", # The hostname of the SMTP service. Required.
237 "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.
238 "port": 42, # The port of the SMTP service. Required.
239 },
240 "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.
241 "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.
242 "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^]243 "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]244 "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.
245 "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.
246 "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.
247 "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.
248}
249
250
251Returns:
252 An object of the form:
253
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]254 { # 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]255 "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.
256 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
257 "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.
258 "host": "A String", # The hostname of the SMTP service. Required.
259 "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.
260 "port": 42, # The port of the SMTP service. Required.
261 },
262 "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.
263 "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.
264 "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^]265 "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]266 "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.
267 "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.
268 "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.
269 "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.
270 }</pre>
271</div>
272
273<div class="method">
274 <code class="details" id="update">update(userId, sendAsEmail, body)</code>
275 <pre>Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.
276
277Args:
278 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
279 sendAsEmail: string, The send-as alias to be updated. (required)
280 body: object, The request body. (required)
281 The object takes the form of:
282
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]283{ # 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]284 "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.
285 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
286 "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.
287 "host": "A String", # The hostname of the SMTP service. Required.
288 "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.
289 "port": 42, # The port of the SMTP service. Required.
290 },
291 "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.
292 "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.
293 "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^]294 "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]295 "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.
296 "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.
297 "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.
298 "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.
299}
300
301
302Returns:
303 An object of the form:
304
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]305 { # 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]306 "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.
307 "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
308 "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.
309 "host": "A String", # The hostname of the SMTP service. Required.
310 "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.
311 "port": 42, # The port of the SMTP service. Required.
312 },
313 "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.
314 "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.
315 "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^]316 "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]317 "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.
318 "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.
319 "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.
320 "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.
321 }</pre>
322</div>
323
324<div class="method">
325 <code class="details" id="verify">verify(userId, sendAsEmail)</code>
326 <pre>Sends a verification email to the specified send-as alias address. The verification status must be pending.
327
328Args:
329 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
330 sendAsEmail: string, The send-as alias to be verified. (required)
331</pre>
332</div>
333
334</body></html>