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