Home | History | Annotate | Download | only in dyn 
      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">
     78   <code><a href="#delete">delete(userId, sendAsEmail, id)</a></code></p>
     79 <p class="firstline">Deletes the specified S/MIME config for the specified send-as alias.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(userId, sendAsEmail, id)</a></code></p>
     82 <p class="firstline">Gets the specified S/MIME config for the specified send-as alias.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(userId, sendAsEmail, body)</a></code></p>
     85 <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>
     86 <p class="toc_element">
     87   <code><a href="#list">list(userId, sendAsEmail)</a></code></p>
     88 <p class="firstline">Lists S/MIME configs for the specified send-as alias.</p>
     89 <p class="toc_element">
     90   <code><a href="#setDefault">setDefault(userId, sendAsEmail, id)</a></code></p>
     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">
     94     <code class="details" id="delete">delete(userId, sendAsEmail, id)</code>
     95   <pre>Deletes the specified S/MIME config for the specified send-as alias.
     96 
     97 Args:
     98   userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
     99   sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
    100   id: string, The immutable ID for the SmimeInfo. (required)
    101 </pre>
    102 </div>
    103 
    104 <div class="method">
    105     <code class="details" id="get">get(userId, sendAsEmail, id)</code>
    106   <pre>Gets the specified S/MIME config for the specified send-as alias.
    107 
    108 Args:
    109   userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
    110   sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
    111   id: string, The immutable ID for the SmimeInfo. (required)
    112 
    113 Returns:
    114   An object of the form:
    115 
    116     { # An S/MIME email config.
    117       "pkcs12": "A String", # 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.
    118       "pem": "A String", # 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).
    119       "issuerCn": "A String", # The S/MIME certificate issuer's common name.
    120       "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
    121       "id": "A String", # The immutable ID for the SmimeInfo.
    122       "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
    123       "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    124     }</pre>
    125 </div>
    126 
    127 <div class="method">
    128     <code class="details" id="insert">insert(userId, sendAsEmail, body)</code>
    129   <pre>Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.
    130 
    131 Args:
    132   userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
    133   sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
    134   body: object, The request body. (required)
    135     The object takes the form of:
    136 
    137 { # An S/MIME email config.
    138     "pkcs12": "A String", # 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     "pem": "A String", # 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).
    140     "issuerCn": "A String", # The S/MIME certificate issuer's common name.
    141     "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
    142     "id": "A String", # The immutable ID for the SmimeInfo.
    143     "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
    144     "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    145   }
    146 
    147 
    148 Returns:
    149   An object of the form:
    150 
    151     { # An S/MIME email config.
    152       "pkcs12": "A String", # 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.
    153       "pem": "A String", # 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).
    154       "issuerCn": "A String", # The S/MIME certificate issuer's common name.
    155       "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
    156       "id": "A String", # The immutable ID for the SmimeInfo.
    157       "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
    158       "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    159     }</pre>
    160 </div>
    161 
    162 <div class="method">
    163     <code class="details" id="list">list(userId, sendAsEmail)</code>
    164   <pre>Lists S/MIME configs for the specified send-as alias.
    165 
    166 Args:
    167   userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
    168   sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
    169 
    170 Returns:
    171   An object of the form:
    172 
    173     {
    174     "smimeInfo": [ # List of SmimeInfo.
    175       { # An S/MIME email config.
    176           "pkcs12": "A String", # 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.
    177           "pem": "A String", # 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).
    178           "issuerCn": "A String", # The S/MIME certificate issuer's common name.
    179           "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
    180           "id": "A String", # The immutable ID for the SmimeInfo.
    181           "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
    182           "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    183         },
    184     ],
    185   }</pre>
    186 </div>
    187 
    188 <div class="method">
    189     <code class="details" id="setDefault">setDefault(userId, sendAsEmail, id)</code>
    190   <pre>Sets the default S/MIME config for the specified send-as alias.
    191 
    192 Args:
    193   userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
    194   sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
    195   id: string, The immutable ID for the SmimeInfo. (required)
    196 </pre>
    197 </div>
    198 
    199 </body></html>