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

blob: 12d7501582140fa610940159e2690bb50262d30c [file] [log] [blame]

Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[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> . <a href="gmail_v1.users.settings.sendAs.smimeInfo.html">smimeInfo</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	78	<code><a href="#delete">delete(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	79	<p class="firstline">Deletes the specified S/MIME config for the specified send-as alias.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	81	<code><a href="#get">get(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	82	<p class="firstline">Gets the specified S/MIME config for the specified send-as alias.</p>
				83	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	84	<code><a href="#insert">insert(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Insert (upload) the given S/MIME config for the specified send-as alias.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	86	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	87	<code><a href="#list">list(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	88	<p class="firstline">Lists S/MIME configs for the specified send-as alias.</p>
				89	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	90	<code><a href="#setDefault">setDefault(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	91	<p class="firstline">Sets the default S/MIME config for the specified send-as alias.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	94	<code class="details" id="delete">delete(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	95	<pre>Deletes the specified S/MIME config for the specified send-as alias.
				96
				97	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	98	userId: string, The user's email address. The special value `me`
				99	can be used to indicate the authenticated user. (required)
				100	sendAsEmail: string, The email address that appears in the "From:" header for mail sent using
				101	this alias. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	102	id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	103	x__xgafv: string, V1 error format.
				104	Allowed values
				105	1 - v1 error format
				106	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	107	</pre>
				108	</div>
				109
				110	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	111	<code class="details" id="get">get(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	112	<pre>Gets the specified S/MIME config for the specified send-as alias.
				113
				114	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	115	userId: string, The user's email address. The special value `me`
				116	can be used to indicate the authenticated user. (required)
				117	sendAsEmail: string, The email address that appears in the "From:" header for mail sent using
				118	this alias. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	119	id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	120	x__xgafv: string, V1 error format.
				121	Allowed values
				122	1 - v1 error format
				123	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	124
				125	Returns:
				126	An object of the form:
				127
				128	{ # An S/MIME email config.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	129	"isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	130	"id": "A String", # The immutable ID for the SmimeInfo.
				131	"pem": "A String", # PEM formatted X509 concatenated certificate string (standard base64
				132	# encoding). Format used for returning key, which includes public key
				133	# as well as certificate chain (not private key).
				134	"expiration": "A String", # When the certificate expires (in milliseconds since epoch).
				135	"pkcs12": "A String", # PKCS#12 format containing a single private/public key pair and
				136	# certificate chain. This format is only accepted from client
				137	# for creating a new SmimeInfo and is never returned, because the
				138	# private key is not intended to be exported. PKCS#12 may be encrypted,
				139	# in which case encryptedKeyPassword should be set appropriately.
				140	"encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	"issuerCn": "A String", # The S/MIME certificate issuer's common name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	143	</div>
				144
				145	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	146	<code class="details" id="insert">insert(userId, sendAsEmail, body=None, x__xgafv=None)</code>
				147	<pre>Insert (upload) the given S/MIME config for the specified send-as alias.
				148	Note that pkcs12 format is required for the key.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	149
				150	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	151	userId: string, The user's email address. The special value `me`
				152	can be used to indicate the authenticated user. (required)
				153	sendAsEmail: string, The email address that appears in the "From:" header for mail sent using
				154	this alias. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	155	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	156	The object takes the form of:
				157
				158	{ # An S/MIME email config.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	159	"isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	160	"id": "A String", # The immutable ID for the SmimeInfo.
				161	"pem": "A String", # PEM formatted X509 concatenated certificate string (standard base64
				162	# encoding). Format used for returning key, which includes public key
				163	# as well as certificate chain (not private key).
				164	"expiration": "A String", # When the certificate expires (in milliseconds since epoch).
				165	"pkcs12": "A String", # PKCS#12 format containing a single private/public key pair and
				166	# certificate chain. This format is only accepted from client
				167	# for creating a new SmimeInfo and is never returned, because the
				168	# private key is not intended to be exported. PKCS#12 may be encrypted,
				169	# in which case encryptedKeyPassword should be set appropriately.
				170	"encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	"issuerCn": "A String", # The S/MIME certificate issuer's common name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	}
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	173
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	174	x__xgafv: string, V1 error format.
				175	Allowed values
				176	1 - v1 error format
				177	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	178
				179	Returns:
				180	An object of the form:
				181
				182	{ # An S/MIME email config.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	"isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	184	"id": "A String", # The immutable ID for the SmimeInfo.
				185	"pem": "A String", # PEM formatted X509 concatenated certificate string (standard base64
				186	# encoding). Format used for returning key, which includes public key
				187	# as well as certificate chain (not private key).
				188	"expiration": "A String", # When the certificate expires (in milliseconds since epoch).
				189	"pkcs12": "A String", # PKCS#12 format containing a single private/public key pair and
				190	# certificate chain. This format is only accepted from client
				191	# for creating a new SmimeInfo and is never returned, because the
				192	# private key is not intended to be exported. PKCS#12 may be encrypted,
				193	# in which case encryptedKeyPassword should be set appropriately.
				194	"encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	"issuerCn": "A String", # The S/MIME certificate issuer's common name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	197	</div>
				198
				199	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	200	<code class="details" id="list">list(userId, sendAsEmail, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	201	<pre>Lists S/MIME configs for the specified send-as alias.
				202
				203	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	204	userId: string, The user's email address. The special value `me`
				205	can be used to indicate the authenticated user. (required)
				206	sendAsEmail: string, The email address that appears in the "From:" header for mail sent using
				207	this alias. (required)
				208	x__xgafv: string, V1 error format.
				209	Allowed values
				210	1 - v1 error format
				211	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	212
				213	Returns:
				214	An object of the form:
				215
				216	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	217	"smimeInfo": [ # List of SmimeInfo.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	218	{ # An S/MIME email config.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	219	"isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	220	"id": "A String", # The immutable ID for the SmimeInfo.
				221	"pem": "A String", # PEM formatted X509 concatenated certificate string (standard base64
				222	# encoding). Format used for returning key, which includes public key
				223	# as well as certificate chain (not private key).
				224	"expiration": "A String", # When the certificate expires (in milliseconds since epoch).
				225	"pkcs12": "A String", # PKCS#12 format containing a single private/public key pair and
				226	# certificate chain. This format is only accepted from client
				227	# for creating a new SmimeInfo and is never returned, because the
				228	# private key is not intended to be exported. PKCS#12 may be encrypted,
				229	# in which case encryptedKeyPassword should be set appropriately.
				230	"encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	231	"issuerCn": "A String", # The S/MIME certificate issuer's common name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	232	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	233	],
				234	}</pre>
				235	</div>
				236
				237	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	238	<code class="details" id="setDefault">setDefault(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	239	<pre>Sets the default S/MIME config for the specified send-as alias.
				240
				241	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	242	userId: string, The user's email address. The special value `me`
				243	can be used to indicate the authenticated user. (required)
				244	sendAsEmail: string, The email address that appears in the "From:" header for mail sent using
				245	this alias. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	246	id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	247	x__xgafv: string, V1 error format.
				248	Allowed values
				249	1 - v1 error format
				250	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	251	</pre>
				252	</div>
				253
				254	</body></html>