Blame - docs/dyn/gmail_v1.users.settings.sendAs.html - platform/external/python/google-api-python-client

blob: 3bbda8b60d1470f6b62fb0710c3feba94b610f49 [file] [log] [blame]

Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.sendAs.html">sendAs</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	86	<code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	87	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	88	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	89	<code><a href="#delete">delete(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	90	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	91	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	92	<code><a href="#get">get(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	93	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	94	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	95	<code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	96	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	97	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	98	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	100	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	101	<code><a href="#update">update(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	102	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	103	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	104	<code><a href="#verify">verify(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	105	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	106	<h3>Method Details</h3>
				107	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	108	<code class="details" id="close">close()</code>
				109	<pre>Close httplib2 connections.</pre>
				110	</div>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	111
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	112	<div class="method">
				113	<code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
				114	<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. This method is only available to service account clients that have been delegated domain-wide authority.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	115
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	116	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	117	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	119	The object takes the form of:
				120
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	121	{ # 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.
				122	"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.
				123	"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.
				124	"port": 42, # The port of the SMTP service. Required.
				125	"host": "A String", # The hostname of the SMTP service. Required.
				126	"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.
				127	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				128	"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.
				129	},
				130	"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.
				131	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				132	"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.
				133	"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. 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	"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.
				135	"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.
				136	"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.
				137	}
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	138
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	139	x__xgafv: string, V1 error format.
				140	Allowed values
				141	1 - v1 error format
				142	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	143
				144	Returns:
				145	An object of the form:
				146
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	147	{ # 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.
				148	"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.
				149	"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.
				150	"port": 42, # The port of the SMTP service. Required.
				151	"host": "A String", # The hostname of the SMTP service. Required.
				152	"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.
				153	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				154	"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.
				155	},
				156	"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.
				157	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				158	"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.
				159	"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. 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	"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.
				161	"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.
				162	"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.
				163	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	164	</div>
				165
				166	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	167	<code class="details" id="delete">delete(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	168	<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 Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	169
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	170	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	171	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	172	sendAsEmail: string, The send-as alias to be deleted. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	173	x__xgafv: string, V1 error format.
				174	Allowed values
				175	1 - v1 error format
				176	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	177	</pre>
				178	</div>
				179
				180	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	181	<code class="details" id="get">get(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	182	<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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	183
				184	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	185	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	186	sendAsEmail: string, The send-as alias to be retrieved. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	187	x__xgafv: string, V1 error format.
				188	Allowed values
				189	1 - v1 error format
				190	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	191
				192	Returns:
				193	An object of the form:
				194
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	195	{ # 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.
				196	"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.
				197	"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.
				198	"port": 42, # The port of the SMTP service. Required.
				199	"host": "A String", # The hostname of the SMTP service. Required.
				200	"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.
				201	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				202	"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.
				203	},
				204	"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.
				205	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				206	"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.
				207	"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. 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	"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.
				209	"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.
				210	"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.
				211	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	212	</div>
				213
				214	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	215	<code class="details" id="list">list(userId, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	216	<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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	217
				218	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	219	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	220	x__xgafv: string, V1 error format.
				221	Allowed values
				222	1 - v1 error format
				223	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	224
				225	Returns:
				226	An object of the form:
				227
				228	{ # Response for the ListSendAs method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	229	"sendAs": [ # List of send-as aliases.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	230	{ # 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.
				231	"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.
				232	"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.
				233	"port": 42, # The port of the SMTP service. Required.
				234	"host": "A String", # The hostname of the SMTP service. Required.
				235	"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.
				236	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				237	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	238	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	239	"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.
				240	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				241	"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.
				242	"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. 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	"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.
				244	"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.
				245	"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.
				246	},
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	247	],
				248	}</pre>
				249	</div>
				250
				251	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	252	<code class="details" id="patch">patch(userId, sendAsEmail, body=None, x__xgafv=None)</code>
				253	<pre>Patch the specified send-as alias.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	254
				255	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	256	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	257	sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	258	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	259	The object takes the form of:
				260
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	261	{ # 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.
				262	"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.
				263	"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.
				264	"port": 42, # The port of the SMTP service. Required.
				265	"host": "A String", # The hostname of the SMTP service. Required.
				266	"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.
				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	},
				270	"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.
				271	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				272	"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.
				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. 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	"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	"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.
				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.
				277	}
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	278
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	279	x__xgafv: string, V1 error format.
				280	Allowed values
				281	1 - v1 error format
				282	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	283
				284	Returns:
				285	An object of the form:
				286
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	287	{ # 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.
				288	"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.
				289	"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.
				290	"port": 42, # The port of the SMTP service. Required.
				291	"host": "A String", # The hostname of the SMTP service. Required.
				292	"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.
				293	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				294	"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.
				295	},
				296	"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.
				297	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				298	"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.
				299	"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. 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	"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.
				301	"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.
				302	"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.
				303	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	304	</div>
				305
				306	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	307	<code class="details" id="update">update(userId, sendAsEmail, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	308	<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 Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	309
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	310	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	311	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	312	sendAsEmail: string, The send-as alias to be updated. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	313	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	314	The object takes the form of:
				315
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	316	{ # 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.
				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	"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.
				319	"port": 42, # The port of the SMTP service. Required.
				320	"host": "A String", # The hostname of the SMTP service. Required.
				321	"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.
				322	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				323	"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.
				324	},
				325	"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.
				326	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				327	"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.
				328	"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. 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	"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.
				330	"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.
				331	"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.
				332	}
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	333
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	334	x__xgafv: string, V1 error format.
				335	Allowed values
				336	1 - v1 error format
				337	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	338
				339	Returns:
				340	An object of the form:
				341
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	342	{ # 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.
				343	"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.
				344	"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.
				345	"port": 42, # The port of the SMTP service. Required.
				346	"host": "A String", # The hostname of the SMTP service. Required.
				347	"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.
				348	"securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
				349	"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.
				350	},
				351	"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.
				352	"signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
				353	"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.
				354	"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. 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	"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.
				356	"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.
				357	"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.
				358	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	359	</div>
				360
				361	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	362	<code class="details" id="verify">verify(userId, sendAsEmail, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	363	<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 Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	364
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	365	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	366	userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	367	sendAsEmail: string, The send-as alias to be verified. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	368	x__xgafv: string, V1 error format.
				369	Allowed values
				370	1 - v1 error format
				371	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	372	</pre>
				373	</div>
				374
				375	</body></html>