blob: 6e3afebff8b59a4ec6b47976a8aed283681858f5 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040082<p class="firstline">Deletes the specified S/MIME config for the specified send-as alias.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#get">get(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040085<p class="firstline">Gets the specified S/MIME config for the specified send-as alias.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#insert">insert(userId, sendAsEmail, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040089<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#list">list(userId, sendAsEmail, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040091<p class="firstline">Lists S/MIME configs for the specified send-as alias.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093 <code><a href="#setDefault">setDefault(userId, sendAsEmail, id, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040094<p class="firstline">Sets the default S/MIME config for the specified send-as alias.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700102 <code class="details" id="delete">delete(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400103 <pre>Deletes the specified S/MIME config for the specified send-as alias.
104
105Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
107 sendAsEmail: string, The email address that appears in the &quot;From:&quot; header for mail sent using this alias. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400108 id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400113</pre>
114</div>
115
116<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700117 <code class="details" id="get">get(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400118 <pre>Gets the specified S/MIME config for the specified send-as alias.
119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
122 sendAsEmail: string, The email address that appears in the &quot;From:&quot; header for mail sent using this alias. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400123 id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400128
129Returns:
130 An object of the form:
131
132 { # An S/MIME email config.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700133 &quot;pem&quot;: &quot;A String&quot;, # PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &quot;issuerCn&quot;: &quot;A String&quot;, # The S/MIME certificate issuer&#x27;s common name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135 &quot;encryptedKeyPassword&quot;: &quot;A String&quot;, # Encrypted key password, when key is encrypted.
136 &quot;expiration&quot;: &quot;A String&quot;, # When the certificate expires (in milliseconds since epoch).
137 &quot;id&quot;: &quot;A String&quot;, # The immutable ID for the SmimeInfo.
138 &quot;pkcs12&quot;: &quot;A String&quot;, # PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.
139 &quot;isDefault&quot;: True or False, # Whether this SmimeInfo is the default one for this user&#x27;s send-as address.
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 }</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400141</div>
142
143<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700144 <code class="details" id="insert">insert(userId, sendAsEmail, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 <pre>Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400146
147Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700148 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
149 sendAsEmail: string, The email address that appears in the &quot;From:&quot; header for mail sent using this alias. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400151 The object takes the form of:
152
153{ # An S/MIME email config.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 &quot;pem&quot;: &quot;A String&quot;, # PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 &quot;issuerCn&quot;: &quot;A String&quot;, # The S/MIME certificate issuer&#x27;s common name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156 &quot;encryptedKeyPassword&quot;: &quot;A String&quot;, # Encrypted key password, when key is encrypted.
157 &quot;expiration&quot;: &quot;A String&quot;, # When the certificate expires (in milliseconds since epoch).
158 &quot;id&quot;: &quot;A String&quot;, # The immutable ID for the SmimeInfo.
159 &quot;pkcs12&quot;: &quot;A String&quot;, # PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.
160 &quot;isDefault&quot;: True or False, # Whether this SmimeInfo is the default one for this user&#x27;s send-as address.
Bu Sun Kim65020912020-05-20 12:08:20 -0700161}
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400162
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400167
168Returns:
169 An object of the form:
170
171 { # An S/MIME email config.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 &quot;pem&quot;: &quot;A String&quot;, # PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Bu Sun Kim65020912020-05-20 12:08:20 -0700173 &quot;issuerCn&quot;: &quot;A String&quot;, # The S/MIME certificate issuer&#x27;s common name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700174 &quot;encryptedKeyPassword&quot;: &quot;A String&quot;, # Encrypted key password, when key is encrypted.
175 &quot;expiration&quot;: &quot;A String&quot;, # When the certificate expires (in milliseconds since epoch).
176 &quot;id&quot;: &quot;A String&quot;, # The immutable ID for the SmimeInfo.
177 &quot;pkcs12&quot;: &quot;A String&quot;, # PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.
178 &quot;isDefault&quot;: True or False, # Whether this SmimeInfo is the default one for this user&#x27;s send-as address.
Bu Sun Kim65020912020-05-20 12:08:20 -0700179 }</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400180</div>
181
182<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 <code class="details" id="list">list(userId, sendAsEmail, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400184 <pre>Lists S/MIME configs for the specified send-as alias.
185
186Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700187 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
188 sendAsEmail: string, The email address that appears in the &quot;From:&quot; header for mail sent using this alias. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400193
194Returns:
195 An object of the form:
196
197 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700198 &quot;smimeInfo&quot;: [ # List of SmimeInfo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400199 { # An S/MIME email config.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 &quot;pem&quot;: &quot;A String&quot;, # PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 &quot;issuerCn&quot;: &quot;A String&quot;, # The S/MIME certificate issuer&#x27;s common name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700202 &quot;encryptedKeyPassword&quot;: &quot;A String&quot;, # Encrypted key password, when key is encrypted.
203 &quot;expiration&quot;: &quot;A String&quot;, # When the certificate expires (in milliseconds since epoch).
204 &quot;id&quot;: &quot;A String&quot;, # The immutable ID for the SmimeInfo.
205 &quot;pkcs12&quot;: &quot;A String&quot;, # PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.
206 &quot;isDefault&quot;: True or False, # Whether this SmimeInfo is the default one for this user&#x27;s send-as address.
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400208 ],
209 }</pre>
210</div>
211
212<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700213 <code class="details" id="setDefault">setDefault(userId, sendAsEmail, id, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400214 <pre>Sets the default S/MIME config for the specified send-as alias.
215
216Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700217 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
218 sendAsEmail: string, The email address that appears in the &quot;From:&quot; header for mail sent using this alias. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400219 id: string, The immutable ID for the SmimeInfo. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400224</pre>
225</div>
226
227</body></html>