Service: zimbraAccount
Namespace: "urn:zimbraAccount"
GetSMIMEPublicCerts SOAP Command

Get SMIME Public Certificates Stores specified in <store> will be attempted in the order they appear in the comma separated list.
e.g.

Network edition only API TRUE
Authorization token required true
Admin Authorization token required false

GetSMIMEPublicCertsRequest

    <GetSMIMEPublicCertsRequest> ## GetSMIMEPublicCertsRequest
        <store [storeLookupOpt="(ANY|ALL)"] [sourceLookupOpt="(ANY|ALL)"]>{storeTypes}</store> ## SMIMEPublicCertsStoreSpec
        (<email>{emails} (String)</email>)*
    </GetSMIMEPublicCertsRequest>

The following table describes elements and attributes you can define within a <GetSMIMEPublicCertsRequest> element:

XPath Required / Optional Description
/store Required (only 1) Type:{storeTypes}
Information on public certificate stores
Description for element text content:Comma separated list of store types
Valid store types:
  1. CONTACT - contacts
  2. GAL - Global Address List (internal and external)
  3. LDAP - external LDAP (see GetSMIMEConfig and ModifySMIMEConfig)
/store@storeLookupOpt Optional (0 or 1) Type:ANY|ALL
Lookup option related to stores.
  • ANY (default) : While iterating through stores, stop if any certs are found in a store and just return those certs - remaining stores will not be attempted.
  • ALL: Always iterate through all specified stores.
/store@sourceLookupOpt Optional (0 or 1) Type:ANY|ALL
Lookup option related to sources configured for stores.
  • ANY : While iterating through multiple sources configured for a store, stop if any certificates are found in one source - remaining configured sources will not be attempted.
  • ALL (default) : Always iterate through all configured sources.
Note: this only applies to the LDAP store.
/email Optional (0 or more) Type:{emails} (String)
List of email addresses

GetSMIMEPublicCertsResponse

    <GetSMIMEPublicCertsResponse> ## GetSMIMEPublicCertsResponse
        <certs [email="{certs-email-address}"]> ## SMIMEPublicCertsInfo
            (<cert store="{cert-store-type} (CONTACT|GAL|LDAP)" field="{cert-store-field}">{value}</cert> ## SMIMEPublicCertInfo)*
         </certs>
    </GetSMIMEPublicCertsResponse>

The following table describes elements and attributes you can define within a <GetSMIMEPublicCertsResponse> element:

XPath Required / Optional Description
/certs Optional (0 or 1) SMIME public certificates
/certs@email Optional (0 or 1) Type:String
Email address
/certs/cert Optional (0 or more) Type:{value}
Certificates
Description for element text content:Base64 encoded cert
/certs/cert@store Required (only 1) Type:CONTACT|GAL|LDAP
Certificate store type
Valid store types:
CONTACT contacts
GAL GAL (internal and external)
LDAP external LDAP (see GetSMIMEConfig and ModifySMIMEConfig
/certs/cert@field Required (only 1) Type:String
Field containing the certificate