CLI Commands
This guide lists and explains all CipherMail cli commands.
ACME
acme account create-keypair
NAME
acme account create-keypair - Create an ACME account keypair
SYNOPSIS
acme account create-keypair [--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>] [--replace-existing-key <true | false>]
OPTIONS
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>
[Optional, default = secp256r1]
--replace-existing-key <true | false>
[Optional, default = false]
acme account find-or-register
NAME
acme account find-or-register - Return or register an account
SYNOPSIS
acme account find-or-register
acme get-tos
NAME
acme get-tos - Gets the Terms Of Service URI
SYNOPSIS
acme get-tos
acme set-tos-accepted
NAME
acme set-tos-accepted - Accept the Terms Of Service
SYNOPSIS
acme set-tos-accepted [--accepted <true | false>]
OPTIONS
--accepted <true | false>
[Optional, default = true]
acme get-tos-accepted
NAME
acme get-tos-accepted - Checks whether the Terms Of Service has been accepted
SYNOPSIS
acme get-tos-accepted
acme account keypair-exists
NAME
acme account keypair-exists - Checks if an ACME account keypair exists
SYNOPSIS
acme account keypair-exists
acme order new
NAME
acme order new - Order a new certificate
SYNOPSIS
acme order new --domains <string-list> [--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>]
OPTIONS
--domains <string-list>
[Mandatory]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>
[Optional, default = secp256r1]
acme order renew
NAME
acme order renew - Renew certificate
SYNOPSIS
acme order renew [--force-renewal <true | false>]
OPTIONS
--force-renewal <true | false>
[Optional, default = false]
acme account deactivate
NAME
acme account deactivate - Deactivate account
SYNOPSIS
acme account deactivate
Auth
auth get oidc-clients
NAME
auth get oidc-clients - List all registered OpenID client registrations
SYNOPSIS
auth get oidc-clients
auth admin delete
NAME
auth admin delete - Delete admin
SYNOPSIS
auth admin delete --name <string>
OPTIONS
--name <string>
name of the admin to delete
[Mandatory]
auth admin roles set
NAME
auth admin roles set - Set roles for an admin
SYNOPSIS
auth admin roles set --name <string> --roles <string-list>
OPTIONS
--name <string>
name of admin
[Mandatory]
--roles <string-list>
roles for the admin
[Mandatory]
auth permissions effective
NAME
auth permissions effective - List permissions for an admin including all inherited permissions from roles
SYNOPSIS
auth permissions effective --name <string>
OPTIONS
--name <string>
name of admin
[Mandatory]
auth role delete
NAME
auth role delete - Delete role
SYNOPSIS
auth role delete --name <string>
OPTIONS
--name <string>
name of role to delete
[Mandatory]
auth role inherited set
NAME
auth role inherited set - Set inherited roles for a role
SYNOPSIS
auth role inherited set --name <string> --inherited-roles <string-list>
OPTIONS
--name <string>
name of role
[Mandatory]
--inherited-roles <string-list>
inherited roles
[Mandatory]
auth permissions all
NAME
auth permissions all - List available permissions
SYNOPSIS
auth permissions all [--filter <string>]
OPTIONS
--filter <string>
Regex to filters permissions
[Optional]
auth admin 2fa caller set enable
NAME
auth admin 2fa caller set enable - Enable two Factor Authentication for the caller
SYNOPSIS
auth admin 2fa caller set enable [--enable <true|false>]
OPTIONS
--enable <true | false>
[Optional, default = false]
auth role create
NAME
auth role create - Create new role
SYNOPSIS
auth role create --name <string>
OPTIONS
--name <string>
name of new role
[Mandatory]
auth role get all
NAME
auth role get all - List available roles
SYNOPSIS
auth role get all
auth role permissions add
NAME
auth role permissions add - Add permissions to a role
SYNOPSIS
auth role permissions add --name <string> --permissions <string-list>
OPTIONS
--name <string>
name of role
[Mandatory]
--permissions <string-list>
permissions to add
[Mandatory]
auth admin get all
NAME
auth admin get all - List all admins
SYNOPSIS
auth admin get all
auth role permissions set
NAME
auth role permissions set - Set permissions of a role
SYNOPSIS
auth role permissions set --name <string> --permissions <string-list>
OPTIONS
--name <string>
name of role
[Mandatory]
--permissions <string-list>
permissions to set
[Mandatory]
auth admin add
NAME
auth admin add - Add new admin
SYNOPSIS
auth admin add --name <string> --authentication-type <username-password | ldap | oidc>
OPTIONS
--name <string>
name of new admin
[Mandatory]
--authentication-type <username-password | ldap | oidc>
[Mandatory]
auth admin 2fa caller get enable
NAME
auth admin 2fa caller get enable - Returns true if two Factor Authentication for the caller is enabled
SYNOPSIS
auth admin 2fa caller get enable
auth admin password
NAME
auth admin password - Set admin password
SYNOPSIS
auth admin password --name <string> --password <string>
OPTIONS
--name <string>
name of admin
[Mandatory]
--password <string>
password for the admin
[Mandatory]
auth role permissions remove
NAME
auth role permissions remove - Remove permissions from a role
SYNOPSIS
auth role permissions remove --name <string> --permissions <string-list>
OPTIONS
--name <string>
name of role
[Mandatory]
--permissions <string-list>
permissions to remove
[Mandatory]
auth admin get
NAME
auth admin get - Get admin details
SYNOPSIS
auth admin get --name <string>
OPTIONS
--name <string>
name of admin
[Mandatory]
auth role get
NAME
auth role get - Get role details
SYNOPSIS
auth role get --name <string>
OPTIONS
--name <string>
name of role
[Mandatory]
auth admin authenticated
NAME
auth admin authenticated - Get authenticated admin details
SYNOPSIS
auth admin authenticated
auth admin ip-addresses clear
NAME
auth admin ip-addresses clear - Clear authorized IP addresses for an admin
SYNOPSIS
auth admin ip-addresses clear --name <string>
OPTIONS
--name <string>
name of admin
[Mandatory]
auth admin 2fa set enable
NAME
auth admin 2fa set enable - Enable Two Factor Authentication for an admin
SYNOPSIS
auth admin 2fa set enable --name <string> [--enable <true | false>
OPTIONS
--name <string>
name of admin
[Mandatory]
--enable <true | false>
[Optional, default = false]
auth admin ip-addresses set
NAME
auth admin ip-addresses set - Set authorized IP addresses for an admin
SYNOPSIS
auth admin ip-addresses set --name <string> [--ip-addresses <string-list>]
OPTIONS
--name <string>
name of admin
[Mandatory]
--ip-addresses <string-list>
IP addresses for the admin
[Mandatory]
Built-in
help
NAME
help - Display help about available commands
SYNOPSIS
help [--command <string>]
OPTIONS
--command <string>
The command to obtain help for.
[Optional]
history
NAME
history - Display or save the history of previously run commands
SYNOPSIS
history [--file <file>]
OPTIONS
--file <file>
A file to save history to.
[Optional]
version
NAME
version - Show version info
SYNOPSIS
version
script
NAME
script - Read and execute commands from a file.
SYNOPSIS
script --file <file>
OPTIONS
--file <file>
[Mandatory]
CA
ca get request-handlers
NAME
ca get request-handlers - List available certificate request handlers
SYNOPSIS
ca get request-handlers
ca create self-signed-certificate
NAME
ca create self-signed-certificate - Create a self-signed certificate
SYNOPSIS
ca create self-signed-certificate --email <string> --subject-common-name <string> --days-valid <int>
[--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>]
[--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>]
[--white-list <true | false>]
[--subject-email <string>]
[--subject-organisation <string>]
[--subject-organisational-unit <string>]
[--subject-country-code <string>]
[--subject-state <string>]
[--subject-locality <string>]
[--subject-given-name <string>]
[--subject-surname <string>]
OPTIONS
--email <string>
[Mandatory]
--subject-common-name <string>
[Mandatory]
--days-valid <int>
[Mandatory]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>
[Optional, default = rsa-3072]
--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>
[Optional, default = sha256-with-rsa-encryption]
--white-list <true | false>
[Optional, default = false]
--subject-email <string>
[Optional]
--subject-organisation <string>
[Optional]
--subject-organisational-unit <string>
[Optional]
--subject-country-code <string>
[Optional]
--subject-state <string>
[Optional]
--subject-locality <string>
[Optional]
--subject-given-name <string>
[Optional]
--subject-surname <string>
[Optional]
ca pending delete
NAME
ca pending delete - Delete the pending requests with the given id
SYNOPSIS
ca pending delete --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
ca pending email
NAME
ca pending email - List all pending requests for an email address
SYNOPSIS
ca pending email --email <string> [--match <exact | like>] [--first-result <int>] [--max-results <int>]
OPTIONS
--email <string>
[Mandatory]
--match <exact | like>
[Optional, default = exact]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
ca pending get all
NAME
ca pending get all - List all pending requests
SYNOPSIS
ca pending get all [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
ca pending get
NAME
ca pending get - Get the pending requests with the given id
SYNOPSIS
ca pending get --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
ca create root
NAME
ca create root - Create a new self-signed root CA certificate
SYNOPSIS
ca create root --subject-common-name <string> --days-valid <int>
[--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>]
[--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>]
[--path-length-constraint <int>]
[--subject-email <string>]
[--subject-organisation <string>]
[--subject-organisational-unit <string>]
[--subject-country-code <string>]
[--subject-state <string>]
[--subject-locality <string>]
[--subject-given-name <string>]
[--subject-surname <string>]
OPTIONS
--subject-common-name <string>
[Mandatory]
--days-valid <int>
[Mandatory]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>
[Optional, default = rsa-3072]
--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>
[Optional, default = sha256-with-rsa-encryption]
--path-length-constraint <int>
[Optional, default = 1]
--subject-email <string>
[Optional]
--subject-organisation <string>
[Optional]
--subject-organisational-unit <string>
[Optional]
--subject-country-code <string>
[Optional]
--subject-state <string>
[Optional]
--subject-locality <string>
[Optional]
--subject-given-name <string>
[Optional]
--subject-surname <string>
[Optional]
The created root CA certificate is stored in the roots store. The returned JSON contains the details of the new certificate, for example the thumbprint, which is required for creating an intermediate CA certificate signed by this root CA.
ca create intermediate
NAME
ca create intermediate - Create a new intermediate CA certificate signed by an existing CA
SYNOPSIS
ca create intermediate --signer-thumbprint <string> --subject-common-name <string> --days-valid <int>
[--store <roots | certificates>]
[--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>]
[--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>]
[--path-length-constraint <int>]
[--crl-distribution-point <url>]
[--subject-email <string>]
[--subject-organisation <string>]
[--subject-organisational-unit <string>]
[--subject-country-code <string>]
[--subject-state <string>]
[--subject-locality <string>]
[--subject-given-name <string>]
[--subject-surname <string>]
OPTIONS
--signer-thumbprint <string>
[Mandatory]
--subject-common-name <string>
[Mandatory]
--days-valid <int>
[Mandatory]
--store <roots | certificates>
[Optional, default = roots]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>
[Optional, default = rsa-3072]
--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>
[Optional, default = sha256-with-rsa-encryption]
--path-length-constraint <int>
[Optional, default = 0]
--crl-distribution-point <url>
[Optional]
--subject-email <string>
[Optional]
--subject-organisation <string>
[Optional]
--subject-organisational-unit <string>
[Optional]
--subject-country-code <string>
[Optional]
--subject-state <string>
[Optional]
--subject-locality <string>
[Optional]
--subject-given-name <string>
[Optional]
--subject-surname <string>
[Optional]
The CA which signs the new intermediate certificate is selected with
--signer-thumbprint. The --store option specifies in which store the
signing CA certificate is searched for: the roots store (the default) or the
certificates store. The new intermediate CA certificate is stored in the
certificates store.
Note
The ca create command, which created a root and an intermediate CA
certificate in one step, has been replaced by ca create root and
ca create intermediate. To create a complete CA, first create the root
CA and then create an intermediate CA signed by the new root CA.
Hint
Certificates issued by a CA can only be validated if a CRL is available for
every CA certificate in the chain. Set --crl-distribution-point to the
URL from which the CRL for the intermediate CA can be downloaded (see also
ca create crl).
ca create crl
NAME
ca create crl - Create a crl
SYNOPSIS
ca create crl --issuer-thumbprint <string> --next-update <timestamp>
[--store <roots | certificates>]
[--update-existing-crl <true | false>]
[--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>]
[--serial-numbers-hex <string-list>]
OPTIONS
--issuer-thumbprint <thumbprint>
[Mandatory]
--next-update <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--update-existing-crl <true | false>
[Optional, default = true]
--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>
[Optional, default = sha256-with-rsa-encryption]
--serial-numbers-hex <string-list>
[Optional]
ca pending finalize
NAME
ca pending finalize - Upload certificate to a matching CSR
SYNOPSIS
ca pending finalize --file <file>
OPTIONS
--file <file>
[Mandatory]
ca request certificate
NAME
ca request certificate - Request a new certificate using the selected certificate request handler
SYNOPSIS
ca request certificate --email <string> --subject-common-name <string> --days-valid <int> --certificate-request-handler <string>
[--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>]
[--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>]
[--subject-email <string>]
[--subject-organisation <string>]
[--subject-organisational-unit <string>]
[--subject-country-code <string>]
[--subject-state <string>]
[--subject-locality <string>]
[--subject-given-name <string>]
[--subject-surname <string>]
[--crl-distribution-point <url>]
OPTIONS
--email <string>
[Mandatory]
--subject-common-name <string>
[Mandatory]
--days-valid <int>
[Mandatory]
--certificate-request-handler <string>
[Mandatory]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1 | brainpoolp512r1 | brainpoolp384r1 | brainpoolp256r1>
[Optional, default = rsa-3072]
--signature-algorithm <sha256-with-rsa-encryption | sha384-with-rsa-encryption | sha512-with-rsa-encryption | sha256-with-ecdsa | sha384-with-ecdsa | sha512-with-ecdsa>
[Optional, default = sha256-with-rsa-encryption]
--subject-email <string>
[Optional]
--subject-organisation <string>
[Optional]
--subject-organisational-unit <string>
[Optional]
--subject-country-code <string>
[Optional]
--subject-state <string>
[Optional]
--subject-locality <string>
[Optional]
--subject-given-name <string>
[Optional]
--subject-surname <string>
[Optional]
--crl-distribution-point <url>
[Optional]
ca pending reschedule
NAME
ca pending reschedule - Reschedule the pending requests with the given id
SYNOPSIS
ca pending reschedule --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
ca pending email count
NAME
ca pending email count - Get the number of pending requests for an email address
SYNOPSIS
ca pending email count --email <string> [--match <exact | like>]
OPTIONS
--email <string>
[Mandatory]
--match <exact | like>
[Optional, default = exact]
ca get available
- NAME
ca get available - List available CA certificates
- SYNOPSIS
ca get available [–key-usage-filter <all | crl-sign>]
- OPTIONS
–key-usage-filter <all | crl-sign> [Optional, default = all]
ca pending count
NAME
ca pending count - Get the number of pending requests
SYNOPSIS
ca pending count
CRL
crl get
NAME
crl get - Get the CRL with the given thumbprint
SYNOPSIS
crl get --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
crl delete
NAME
crl delete - Delete the CRL with the given thumbprint
SYNOPSIS
crl delete --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
crl get all
NAME
crl get all - List all CRLs
SYNOPSIS
crl get all [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
crl refresh
NAME
crl refresh - Force the download of new CRLs
SYNOPSIS
crl refresh
crl validate
NAME
crl validate - Validate the CRL
SYNOPSIS
crl validate --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
crl export
NAME
crl export - Export CRLs to a DER or PEM encoded file
SYNOPSIS
crl export --thumbprints <string> --output-file <file> [--encoding <der | pem>]
OPTIONS
--thumbprints <string>
[Mandatory]
--output-file <file>
[Mandatory]
--encoding <der | pem>
[Optional, default = pem]
crl get all count
NAME
crl get all count - Get the number of CRLs
SYNOPSIS
crl get all count
crl import
NAME
crl import - Import CRLs from a file
SYNOPSIS
crl import --file <file> [--skip-expired <true | false>]
OPTIONS
--file <file>
[Mandatory]
--skip-expired <true | false>
[Optional, default = true]
CTL
ctl set
NAME
ctl set - Configure the certificate trust list with the given certificate thumbprint
SYNOPSIS
ctl set --thumbprint <string> --status <blacklisted | whitelisted> [--allow-expired <true | false>]
OPTIONS
--thumbprint <string>
[Mandatory]
--status <blacklisted | whitelisted>
[Mandatory]
--allow-expired <true | false>
[Optional, default = false]
ctl get all count
NAME
ctl get all count - Get the number of certificate trust list entries
SYNOPSIS
ctl get all count
ctl delete
----------
.. code-block:: console
NAME
ctl delete - Delete the certificate trust list with the given certificate thumbprint
SYNOPSIS
ctl delete --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
ctl get all
NAME
ctl get all - List all CTLs
SYNOPSIS
ctl get all [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
ctl get
NAME
ctl get - Get the certificate trust list with the given certificate thumbprint
SYNOPSIS
ctl get --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
Certificate
certificate get matching count
NAME
certificate get matching count - Get the number of matching certificates
SYNOPSIS
certificate get matching count [--store <roots | certificates>] [--expired <match-all | match-unexpired-only | match-expired-only>] [--missing-key-alias <allowed | not-allowed>]
OPTIONS
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
certificate search email count
NAME
certificate search email count - Get the number of certificates matching the email address
SYNOPSIS
certificate search email count --email <string>
[--store <roots | certificates>]
[--match <exact | like>
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
OPTIONS
--email <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--match <exact | like>
[Optional, default = exact]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
certificate search subject count
NAME
certificate search subject count - Get the number of certificates matching the subject
SYNOPSIS
certificate search subject count --subject <string>
[--store <roots | certificates>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
OPTIONS
--subject <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
certificate export chain
NAME
certificate export chain - Export the certificate chain of a certificate to a DER or PEM encoded file
SYNOPSIS
certificate export chain --thumbprint <string> --output-file <file> [--encoding <der | pem>]
OPTIONS
--thumbprint <string>
[Mandatory]
--output-file <file>
[Mandatory]
--encoding <der | pem>
[Optional, default = pem]
certificate referenced
NAME
certificate referenced - Checks if the certificate is referenced
SYNOPSIS
certificate referenced --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate export certificates
NAME
certificate export certificates - Export certificates to a DER or PEM encoded file
SYNOPSIS
certificate export certificates --thumbprints <string-list> --output-file <file> [--store <roots | certificates>] [--encoding <der | pem>]
OPTIONS
--thumbprints <string-list>
[Mandatory]
--output-file <file>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--encoding <der | pem>
[Optional, default = pem]
certificate referenced details
NAME
certificate referenced details - List all the references to a certificate
SYNOPSIS
certificate referenced details --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate import keys
NAME
certificate import keys - Import private keys from a PKCS#12 or PEM file
SYNOPSIS
certificate import keys --keystore-password <string> --file <file> [--store <roots | certificates>] [--missing-key-action <skip-certificate-only-entry | add-certificate-only-entry>]
OPTIONS
--keystore-password <string>
[Mandatory]
--file <file>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--missing-key-action <skip-certificate-only-entry | add-certificate-only-entry>
[Optional, default = add-certificate-only-entry]
certificate get matching
NAME
certificate get matching - List all matching certificates
SYNOPSIS
certificate get matching [--store <roots | certificates>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
certificate delete
NAME
certificate delete - Delete a certificate
SYNOPSIS
certificate delete --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate get all
NAME
certificate get all - List all certificates
SYNOPSIS
certificate get all [--store <roots | certificates>] [--first-result <int>] [--max-results <int>]
OPTIONS
--store <roots | certificates>
[Optional, default = certificates]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
certificate import
NAME
certificate import - Import certificates from a file
SYNOPSIS
certificate import --file <file> [--store <roots | certificates>] [--certificate-import-action <import-all | skip-self-signed | must-be-self-signed>]
OPTIONS
--file <file>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--certificate-import-action <import-all | skip-self-signed | must-be-self-signed>
[Optional, default = import-all]
certificate import system-roots
NAME
certificate import system-roots - Import default system root certificates
SYNOPSIS
certificate import system-roots
certificate search issuer count
-------------------------------
.. code-block:: console
NAME
certificate search issuer count - Get the number of certificates matching the issuer
SYNOPSIS
certificate search issuer count --issuer <string>
[--store <roots | certificates>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
OPTIONS
--issuer <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
certificate search issuer
NAME
certificate search issuer - List all certificates matching the issuer
SYNOPSIS
certificate search issuer --issuer <string>
[--store <roots | certificates>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--issuer <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
certificate search subject
NAME
certificate search subject - List all certificates matching the subject
SYNOPSIS
certificate search subject --subject <string>
[--store <roots | certificates>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--subject <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
certificate get all count
NAME
certificate get all count - Get the number of all certificates
SYNOPSIS
certificate get all count [--store <roots | certificates>]
OPTIONS
--store <roots | certificates>
[Optional, default = certificates]
certificate search email
NAME
certificate search email - List all certificates matching the email address
SYNOPSIS
certificate search email --email <string>
[--store <roots | certificates>]
[--match <exact | like>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--email <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--match <exact | like>
[Optional, default = exact]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
certificate get external
NAME
certificate get external - Get certificate details without importing the certificate
SYNOPSIS
certificate get external --file <file>
OPTIONS
--file <file>
[Mandatory]
certificate get
NAME
certificate get - Get the certificate with the given thumbprint
SYNOPSIS
certificate get --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate export keys
NAME
certificate export keys - Export private keys to PKCS#12 or PEM encoded file
SYNOPSIS
certificate export keys --thumbprints <string-list> --keystore-password <string> --output-file <file>
[--store <roots | certificates>]
[--key-export-format <pkcs12 | pem>]
[--include-root <true | false>]
OPTIONS
--thumbprints <string-list>
[Mandatory]
--keystore-password <string>
[Mandatory]
--output-file <file>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
--key-export-format <pkcs12 | pem>
[Optional, default = pkcs12]
--include-root <true | false>
[Optional, default = true]
Certificate Selection
certificate selection user get auto-selected
NAME
certificate selection user get auto-selected - List auto selected encryption certificates for a user
SYNOPSIS
certificate selection user get auto-selected --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection domain reset named
NAME
certificate selection domain reset named - Reset named certificates for a domain
SYNOPSIS
certificate selection domain reset named --domain <string> [--category <additional>]]
OPTIONS
--domain <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection domain get signing
NAME
certificate selection domain get signing - Get signing certificate for a domain
SYNOPSIS
certificate selection domain get signing --domain <string>
OPTIONS
--domain <string>
[Mandatory]
certificate selection user reset signing
NAME
certificate selection user reset signing - Reset signing certificate for a user
SYNOPSIS
certificate selection user reset signing --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection domain reset signing
NAME
certificate selection domain reset signing - Reset signing certificate for a domain
SYNOPSIS
certificate selection domain reset signing --domain <string>
OPTIONS
--domain <string>
[Mandatory]
certificate selection user get named inherited
NAME
certificate selection user get named inherited - List inherited named certificates for a user
SYNOPSIS
certificate selection user get named inherited --email <string> [--category <additional>]
OPTIONS
--email <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection user get named
NAME
certificate selection user get named - List named certificates for a user
SYNOPSIS
certificate selection user get named --email <string> [--category <additional>]
OPTIONS
--email <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection user reset explicit
NAME
certificate selection user reset explicit - Reset manually selected certificates for a user
SYNOPSIS
certificate selection user reset explicit --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection domain get explicit
NAME
certificate selection domain get explicit - List manually selected certificates for a domain
SYNOPSIS
certificate selection domain get explicit --domain <string>
OPTIONS
--domain <string>
[Mandatory]
certificate selection user get explicit
NAME
certificate selection user get explicit - List manually selected certificates for a user
SYNOPSIS
certificate selection user get explicit --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection global set named
NAME
certificate selection global set named - Set named certificates for the global settings
SYNOPSIS
certificate selection global set named --thumbprints <string-list> [--category <additional>]
OPTIONS
--thumbprints <string-list>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection global get named
NAME
certificate selection global get named - List named certificates for the global settings
SYNOPSIS
certificate selection global get named [--category <additional>]
OPTIONS
--category <additional>
[Optional, default = additional]
certificate selection user reset named
NAME
certificate selection user reset named - Reset named certificates for a user
SYNOPSIS
certificate selection user reset named --email <string> [--category <additional>]
OPTIONS
--email <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection domain get inherited
NAME
certificate selection domain get inherited - List inherited certificates for a domain
SYNOPSIS
certificate selection domain get inherited --domain <string>
OPTIONS
--domain <string>
[Mandatory]
certificate selection global set signing
NAME
certificate selection global set signing - Set signing certificate for the global settings
SYNOPSIS
certificate selection global set signing --thumbprint <string>
OPTIONS
--thumbprint <string>
[Mandatory]
certificate selection domain reset explicit
NAME
certificate selection domain reset explicit - Reset manually selected certificates for a domain
SYNOPSIS
certificate selection domain reset explicit --domain <string>
OPTIONS
--domain <string>
[Mandatory]
certificate selection user get encryption
NAME
certificate selection user get encryption - List encryption certificates for a user
SYNOPSIS
certificate selection user get encryption --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection global get signing
NAME
certificate selection global get signing - Get signing certificate for the global settings
SYNOPSIS
certificate selection global get signing
certificate selection domain get named
NAME
certificate selection domain get named - List named certificates for a domain
SYNOPSIS
certificate selection domain get named --domain <string> [--category <additional>]
OPTIONS
--domain <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection global reset named
NAME
certificate selection global reset named - Reset named certificates for the global settings
SYNOPSIS
certificate selection global reset named [--category <additional>]
OPTIONS
--category <additional>
[Optional, default = additional]
certificate selection user get inherited
NAME
certificate selection user get inherited - List inherited certificates for a user
SYNOPSIS
certificate selection user get inherited --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection user set explicit
NAME
certificate selection user set explicit - Set manually selected certificates for a user
SYNOPSIS
certificate selection user set explicit --email <string> --thumbprints <string-list>
OPTIONS
--email <string>
[Mandatory]
--thumbprints <string-list>
[Mandatory]
certificate selection user set signing
NAME
certificate selection user set signing - Set signing certificate for a user
SYNOPSIS
certificate selection user set signing --email <string> --thumbprint <string>
OPTIONS
--email <string>
[Mandatory]
--thumbprint <string>
[Mandatory]
certificate selection user get signing
NAME
certificate selection user get signing - Get signing certificate for a user
SYNOPSIS
certificate selection user get signing --email <string>
OPTIONS
--email <string>
[Mandatory]
certificate selection user set named
NAME
certificate selection user set named - Set named certificates for a user
SYNOPSIS
certificate selection user set named --email <string> --thumbprints <string-list> [--category <additional>]
OPTIONS
--email <string>
[Mandatory]
--thumbprints <string-list>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection domain set named
NAME
certificate selection domain set named - Set named certificates for a domain
SYNOPSIS
certificate selection domain set named --domain <string> --thumbprints <string-list> [--category <additional>]
OPTIONS
--domain <string>
[Mandatory]
--thumbprints <string-list>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection domain get named inherited
NAME
certificate selection domain get named inherited - List inherited named certificates for a domain
SYNOPSIS
certificate selection domain get named inherited --domain <string> [--category <additional>]
OPTIONS
--domain <string>
[Mandatory]
--category <additional>
[Optional, default = additional]
certificate selection domain set explicit
NAME
certificate selection domain set explicit - Set manually selected certificates for a domain
SYNOPSIS
certificate selection domain set explicit --domain <string> --thumbprints <string-list>
OPTIONS
--domain <string>
[Mandatory]
--thumbprints <string-list>
[Mandatory]
certificate selection domain set signing
NAME
certificate selection domain set signing - Set signing certificate for a domain
SYNOPSIS
certificate selection domain set signing --domain <string> --thumbprint <string>
OPTIONS
--domain <string>
[Mandatory]
--thumbprint <string>
[Mandatory]
certificate selection global reset signing
NAME
certificate selection global reset signing - Reset signing certificate for the global settings
SYNOPSIS
certificate selection global reset signing
Certificate Validation
certificate validation validate signing external
NAME
certificate validation validate signing external - Check if the certificate is valid for signing without importing the certificate
SYNOPSIS
certificate validation validate signing external --file <file> [--thumbprint <string>]
OPTIONS
--file <file>
[Mandatory]
--thumbprint <string>
[Optional]
certificate validation validate external
NAME
certificate validation validate external - Check if the certificate is valid without importing the certificate
SYNOPSIS
certificate validation validate external --file <file> [--thumbprint <string>]
OPTIONS
--file <file>
[Mandatory]
--thumbprint <string>
[Optional]
certificate validation validate
NAME
certificate validation validate - Check if the certificate is valid
SYNOPSIS
certificate validation validate --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate validation get issuer
NAME
certificate validation get issuer - Gets the issuer certificate
SYNOPSIS
certificate validation get issuer --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate validation validate signing
NAME
certificate validation validate signing - Check if the certificate is valid for signing
SYNOPSIS
certificate validation validate signing --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
certificate validation validate encryption external
NAME
certificate validation validate encryption external - Check if the certificate is valid for encryption without importing the certificate
SYNOPSIS
certificate validation validate encryption external --file <file> [--thumbprint <string>]
OPTIONS
--file <file>
[Mandatory]
--thumbprint <string>
[Optional]
certificate validation validate encryption
NAME
certificate validation validate encryption - Check if the certificate is valid for encryption
SYNOPSIS
certificate validation validate encryption --thumbprint <string> [--store <roots | certificates>]
OPTIONS
--thumbprint <string>
[Mandatory]
--store <roots | certificates>
[Optional, default = certificates]
DKIM
dkim set key
NAME
dkim set key - Set DKIM key
SYNOPSIS
dkim set key --key-id <string> [--pem-encoded-key-pair <string>] [--file <file>]
OPTIONS
--key-id <string>
[Mandatory]
--pem-encoded-key-pair <string>
[Optional]
--file <file>
[Optional]
dkim get key-pair
NAME
dkim get key-pair - Get DKIM key pair
SYNOPSIS
dkim get key-pair --key-id <string>
OPTIONS
--key-id <string>
[Mandatory]
dkim get key-ids
NAME
dkim get key-ids - List all DKIM key ids
SYNOPSIS
dkim get key-ids [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
dkim parse-signature-template
NAME
dkim parse-signature-template - Parse a DKIM signature template
SYNOPSIS
dkim parse-signature-template --signature-template <string>
OPTIONS
--signature-template <string>
[Mandatory]
dkim delete key
NAME
dkim delete key - Delete DKIM key
SYNOPSIS
dkim delete key --key-id <string>
OPTIONS
--key-id <string>
[Mandatory]
dkim get public-key
NAME
dkim get public-key - Get DKIM public key
SYNOPSIS
dkim get public-key --key-id <string>
OPTIONS
--key-id <string>
[Mandatory]
dkim generate key
NAME
dkim generate key - Generate a new DKIM key
SYNOPSIS
dkim generate key --key-id <string> [--key-length <1024 | 2048 | 3072 | 4096>]
OPTIONS
--key-id <string>
[Mandatory]
--key-length <1024 | 2048 | 3072 | 4096>
[Optional, default = 2048]
dkim get available
NAME
dkim get available - Returns true if a key with the given id is available
SYNOPSIS
dkim get available --key-id <string>
OPTIONS
--key-id <string>
[Mandatory]
DLP
dlp domain get patterns
NAME
dlp domain get patterns - Lists policy patterns assigned to a domain
SYNOPSIS
dlp domain get patterns --domain <string>
OPTIONS
--domain <string>
[Mandatory]
dlp user reset patterns
NAME
dlp user reset patterns - Removes policy patterns assigned to a user
SYNOPSIS
dlp user reset patterns --email <string>
OPTIONS
--email <string>
[Mandatory]
dlp user get patterns
NAME
dlp user get patterns - Lists policy patterns assigned to a user
SYNOPSIS
dlp user get patterns --email <string>
OPTIONS
--email <string>
[Mandatory]
dlp user set patterns
NAME
dlp user set patterns - Assigns policy patterns to a user
SYNOPSIS
dlp user set patterns --email <string> [--pattern-names <string-list>]
OPTIONS
--email <string>
[Mandatory]
--pattern-names <string-list>
[Mandatory]
dlp child remove
NAME
dlp child remove - Remove a child pattern
SYNOPSIS
dlp child remove --parent-node <string> --child-node <string>
OPTIONS
--parent-node <string>
[Mandatory]
--child-node <string>
[Mandatory]
dlp pattern get all count
NAME
dlp pattern get all count - Get the number of DLP policy patterns
SYNOPSIS
dlp pattern get all count
dlp match-filter get all
NAME
dlp match-filter get all - Lists all match filters
SYNOPSIS
dlp match-filter get all
dlp global reset patterns
NAME
dlp global reset patterns - Removes policy patterns assigned to the global settings
SYNOPSIS
dlp global reset patterns
dlp validator get
NAME
dlp validator get - Get validator
SYNOPSIS
dlp validator get --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp skip-list get
NAME
dlp skip-list get - Get skip list
SYNOPSIS
dlp skip-list get
dlp extract text
NAME
dlp extract text - Extract text from a MIME message
SYNOPSIS
dlp extract text --file <file> [--output-file <file>]
OPTIONS
--file <file>
[Mandatory]
--output-file <file>
[Optional]
dlp domain set patterns
NAME
dlp domain set patterns - Assigns policy patterns to a domain
SYNOPSIS
dlp domain set patterns --domain <string> --pattern-names <string-list>
OPTIONS
--domain <string>
[Mandatory]
--pattern-names <string-list>
[Mandatory]
dlp pattern referenced
NAME
dlp pattern referenced - Checks if the DLP policy pattern is referenced
SYNOPSIS
dlp pattern referenced --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp pattern delete
NAME
dlp pattern delete - Delete a DLP policy pattern
SYNOPSIS
dlp pattern delete --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp group add
NAME
dlp group add - Add a DLP policy group
SYNOPSIS
dlp group add --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp match-filter get
NAME
dlp match-filter get - Get match filter
SYNOPSIS
dlp match-filter get --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp pattern add
NAME
dlp pattern add - Add a DLP policy pattern
SYNOPSIS
dlp pattern add --name <string> --reg-ex <string> --action <warn | must-encrypt | quarantine | block>
[--description <string>]
[--notes <string>]
[--validator <string>]
[--threshold <int>]
[--delay-evaluation <true | false>]
[--match-filter <string>]
OPTIONS
--name <string>
[Mandatory]
--reg-ex <string>
[Mandatory]
--action <warn | must-encrypt | quarantine | block>
[Mandatory]
--description <string>
[Optional]
--notes <string>
[Optional]
--validator <string>
[Optional]
--threshold <int>
[Optional, default = 1]
--delay-evaluation <true | false>
[Optional, default = false]
--match-filter <string>
[Optional]
dlp domain reset patterns
NAME
dlp domain reset patterns - Removes policy patterns assigned to a domain
SYNOPSIS
dlp domain reset patterns --domain <string>
OPTIONS
--domain <string>
[Mandatory]
dlp pattern get
NAME
dlp pattern get - Get a DLP policy pattern
SYNOPSIS
dlp pattern get --name <string>
OPTIONS
--name <string>
[Mandatory]
dlp global get patterns
NAME
dlp global get patterns - Lists policy patterns assigned to the global settings
SYNOPSIS
dlp global get patterns
dlp global set patterns
NAME
dlp global set patterns - Assigns policy patterns to the global settings
SYNOPSIS
dlp global set patterns --pattern-names <string-list>
OPTIONS
--pattern-names string-list
[Mandatory]
dlp pattern get all
NAME
dlp pattern get all - Get all DLP policy patterns
SYNOPSIS
dlp pattern get all --first-result <int> --max-results <int>
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
dlp validator get all
NAME
dlp validator get all - Lists all validators
SYNOPSIS
dlp validator get all
dlp pattern update
NAME
dlp pattern update - Update a DLP policy pattern
SYNOPSIS
dlp pattern update --name <string> --reg-ex <string> --action <warn | must-encrypt | quarantine | block>
[--description <string>]
[--notes <string>]
[--validator <string>]
[--threshold <int>]
[--delay-evaluation <true | false>]
[--match-filter <string>]
OPTIONS
--name <string>
[Mandatory]
--reg-ex <string>
[Mandatory]
--action <warn | must-encrypt | quarantine | block>
[Mandatory]
--description <string>
[Optional]
--notes <string>
[Optional]
--validator <string>
[Optional]
--threshold <int>
[Optional, default = 1]
--delay-evaluation <true | false>
[Optional, default = false]
--match-filter <string>
[Optional]
dlp skip-list set
NAME
dlp skip-list set - Set skip list
SYNOPSIS
dlp skip-list set --file <file>
OPTIONS
--file <file>
[Mandatory]
dlp child add
NAME
dlp child add - Add a child pattern
SYNOPSIS
dlp child add --parent-node <string> --child-node <string>
OPTIONS
--parent-node <string>
[Mandatory]
--child-node <string>
[Mandatory]
dlp pattern rename
NAME
dlp pattern rename - Delete a DLP policy pattern
SYNOPSIS
dlp pattern rename --old-name <string> --new-name <string>
OPTIONS
--old-name <string>
[Mandatory]
--new-name <string>
[Mandatory]
dlp pattern referenced details
NAME
dlp pattern referenced details - Lists all references to a DLP policy pattern
SYNOPSIS
dlp pattern referenced details --name <string>
OPTIONS
--name <string>
[Mandatory]
Domain
domain get all
NAME
domain get all - List all domains
SYNOPSIS
domain get all [--sort-direction <asc | desc>] [--first-result <int>] [--max-results <int>]
OPTIONS
--sort-direction <asc | desc>
[Optional, default = asc]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
domain check
NAME
domain check - Checks if a domain is configured
SYNOPSIS
domain check --domain <string>
OPTIONS
--domain <string>
[Mandatory]
domain add
NAME
domain add - Add new domain
SYNOPSIS
domain add --domain <string>
OPTIONS
--domain <string>
[Mandatory]
domain delete
NAME
domain delete - Delete domain
SYNOPSIS
domain delete --domain <string>
OPTIONS
--domain <string>
[Mandatory]
domain get all count
NAME
domain get all count - Get the number of domains
SYNOPSIS
domain get all count
domain check use
NAME
domain check use - Check if the domain is in use
SYNOPSIS
domain check use --domain <string>
OPTIONS
--domain <string>
[Mandatory]
GlobalSign
globalsign atlas get issuance-quota
NAME
globalsign atlas get issuance-quota - Get the remaining certificate issuance quota from the calling account
SYNOPSIS
globalsign atlas get issuance-quota
globalsign atlas revoke certificate
NAME
globalsign atlas revoke certificate - Revoke an issued certificate
SYNOPSIS
globalsign atlas revoke certificate --serial-number <string>
OPTIONS
--serial-number <string>
[Mandatory]
globalsign atlas download trust-chain
NAME
globalsign atlas download trust-chain - Download the GlobalSign intermediate and root certificate chain
SYNOPSIS
globalsign atlas download trust-chain [--output-file <file>]
OPTIONS
--output-file <file>
[Optional]
globalsign atlas get issued-count
NAME
globalsign atlas get issued-count - Get the number of issued certificates
SYNOPSIS
globalsign atlas get issued-count
globalsign atlas add domain-claim
NAME
globalsign atlas add domain-claim - Add a new domain claim
SYNOPSIS
globalsign atlas add domain-claim --domain <string>
OPTIONS
--domain <string>
[Mandatory]
globalsign atlas create mtls-certificate-request
NAME
globalsign atlas create mtls-certificate-request - Create an mTLS certificate request (PKCS#10)
SYNOPSIS
globalsign atlas create mtls-certificate-request [--output-file <file>]
OPTIONS
--output-file <file>
[Optional]
globalsign atlas get revoked-count
NAME
globalsign atlas get revoked-count - Get the number of revoked certificates
SYNOPSIS
globalsign atlas get revoked-count
globalsign atlas get validation-policy
NAME
globalsign atlas get validation-policy - Get the validation policy
SYNOPSIS
globalsign atlas get validation-policy [--output-file <file>]
OPTIONS
--output-file <file>
[Optional]
globalsign atlas get domain-claims
NAME
globalsign atlas get domain-claims - List all registered domains
SYNOPSIS
globalsign atlas get domain-claims [--domain <string>] [--status <all | pending | verified>] [--page <int>] [--per-page <int>]
OPTIONS
--domain <string>
[Optional]
--status <all | pending | verified>
[Optional, default = all]
--page <int>
[Optional]
--per-page <int>
[Optional]
globalsign atlas verify domain by-email
NAME
globalsign atlas verify domain by-email - Verify domain by email
SYNOPSIS
globalsign atlas verify domain by-email --id <string> --email <string>
OPTIONS
--id <string>
[Mandatory]
--email <string>
[Mandatory]
globalsign atlas verify domain by-dns
NAME
globalsign atlas verify domain by-dns - Verify domain by DNS
SYNOPSIS
globalsign atlas verify domain by-dns --id <string> --authorization-domain <string>
OPTIONS
--id <string>
[Mandatory]
--authorization-domain <string>
[Mandatory]
globalsign atlas get pending mtls-certificate-request
NAME
globalsign atlas get pending mtls-certificate-request - Get the pending mTLS certificate request (PKCS#10)
SYNOPSIS
globalsign atlas get pending mtls-certificate-request [--output-file <file>]
OPTIONS
--output-file <file>
[Optional]
globalsign atlas delete domain-claim
NAME
globalsign atlas delete domain-claim - Delete a domain claim
SYNOPSIS
globalsign atlas delete domain-claim --id <string>
OPTIONS
--id <string>
[Mandatory]
globalsign atlas download certificate
NAME
globalsign atlas download certificate - Download an issued certificate
SYNOPSIS
globalsign atlas download certificate --serial-number <string> [--output-file <file>]
OPTIONS
--serial-number <string>
[Mandatory]
--output-file <file>
[Optional]
globalsign atlas get domain-approval-email-addresses
NAME
globalsign atlas get domain-approval-email-addresses - List the domain approval email addresses
SYNOPSIS
globalsign atlas get domain-approval-email-addresses --id <string>
OPTIONS
--id <string>
[Mandatory]
globalsign atlas import mtls-certificate
NAME
globalsign atlas import mtls-certificate - Import an mTLS certificate
SYNOPSIS
globalsign atlas import mtls-certificate --certificate-file <file>
OPTIONS
--certificate-file <file>
[Mandatory]
Host Resources
host resources reset resource
NAME
host resources reset resource - Resets a public host resource
SYNOPSIS
host resources reset resource --id <string> [--hostname <string>]
OPTIONS
--id <string>
[Mandatory]
--hostname <string>
[Optional]
host resources get encoded-resource
NAME
host resources get encoded-resource - Returns an encoded public host resource
SYNOPSIS
host resources get encoded-resource --id <string> [--hostname <string>]
OPTIONS
--id <string>
[Mandatory]
--hostname <string>
[Optional]
host resources set resource
NAME
host resources set resource - Sets a public host resource
SYNOPSIS
host resources set resource --id <string> --file <file> [--hostname <string>]
OPTIONS
--id <string>
[Mandatory]
--file <file>
[Mandatory]
--hostname <string>
[Optional]
KeyStore
keystore import pkcs12
NAME
keystore import pkcs12 - Import private keys from a PKCS#12 file
SYNOPSIS
keystore import pkcs12 --keystore-name <cert | pgp | dkim> --keystore-password <string> --file <file>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--keystore-password <string>
[Mandatory]
--file <file>
[Mandatory]
keystore delete
NAME
keystore delete - Delete the entry with the given alias
SYNOPSIS
keystore delete --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
keystore rename
NAME
keystore rename - Rename the entry with the given alias
SYNOPSIS
keystore rename --keystore-name <cert | pgp | dkim> --old-alias <string> --new-alias <string> --keystore-password <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--old-alias <string>
[Mandatory]
--new-alias <string>
[Mandatory]
--keystore-password <string>
[Mandatory]
keystore is key
NAME
keystore is key - Checks whether the entry with the given alias is a key
SYNOPSIS
keystore is key --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
keystore export pkcs12
NAME
keystore export pkcs12 - Export private keys to PKCS#12
SYNOPSIS
keystore export pkcs12 --keystore-name <cert | pgp | dkim> --keystore-password <string> --export-password <string> --aliases <string-list> --output-file <file>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--keystore-password <string>
[Mandatory]
--export-password <string>
[Mandatory]
--aliases <string-list>
[Mandatory]
--output-file <file>
[Mandatory]
keystore get certificate
NAME
keystore get certificate - Get the certificate with the given alias
SYNOPSIS
keystore get certificate --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
keystore is certificate
NAME
keystore is certificate - Checks whether the entry with the given alias is a certificate
SYNOPSIS
keystore is certificate --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
keystore aliases
NAME
keystore aliases - Lists all key aliases
SYNOPSIS
keystore aliases --keystore-name <cert | pgp | dkim> [--first-result <int>] [--max-results <int>]
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
keystore get chain
NAME
keystore get chain - Get the certificate chain of the certificate with the given alias
SYNOPSIS
keystore get chain --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
keystore aliases count
NAME
keystore aliases count - Return the number of keystore entries
SYNOPSIS
keystore aliases count --keystore-name <cert | pgp | dkim>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
keystore contains alias
NAME
keystore contains alias - Checks whether an entry with the given alias exists
SYNOPSIS
keystore contains alias --keystore-name <cert | pgp | dkim> --alias <string>
OPTIONS
--keystore-name <cert | pgp | dkim>
[Mandatory]
--alias <string>
[Mandatory]
License
license assign-user
NAME
license assign-user - Assign user license
SYNOPSIS
license assign-user --email <string>
OPTIONS
--email <string>
[Mandatory]
license users set
NAME
license users set - Set licensed users from a file
SYNOPSIS
license users set --licensed-users-file <file>
OPTIONS
--licensed-users-file <file>
[Mandatory]
license delete
NAME
license delete - Delete license
SYNOPSIS
license delete --id <string>
OPTIONS
--id <string>
[Mandatory]
license max-user-licenses
NAME
license max-user-licenses - Gets the max number of user licenses
SYNOPSIS
license max-user-licenses
license import
NAME
license import - Import license from a file
SYNOPSIS
license import --license-file <file>
OPTIONS
--license-file <file>
[Mandatory]
license remove-user
NAME
license remove-user - Remove user license
SYNOPSIS
license remove-user --email <string>
OPTIONS
--email <string>
[Mandatory]
license active
NAME
license active - Get the active license
SYNOPSIS
license active
license users get
NAME
license users get - List licensed users
SYNOPSIS
license users get
license is-user-licensed
NAME
license is-user-licensed - Checks if the user is licensed
SYNOPSIS
license is-user-licensed --email <string>
OPTIONS
--email <string>
[Mandatory]
license validate
NAME
license validate - Validate license without importing
SYNOPSIS
license validate --license-file <file>
OPTIONS
--license-file <file>
[Mandatory]
license check
NAME
license check - Checks if there is a valid license
SYNOPSIS
license check
license available-user-licenses
NAME
license available-user-licenses - Return the number of available user licenses
SYNOPSIS
license available-user-licenses
license list
NAME
license list - List all licenses
SYNOPSIS
license list
Log
log get
NAME
log get - List log lines
SYNOPSIS
log get [--log-target <mpa | mta | imap>] [--reverse <true | false>] [--first-result <int>] [--max-results <int>] [--filter <string>] [--since <string>] [--until <string>]
OPTIONS
--log-target <mpa | mta | imap>
[Optional, default = mta]
--reverse <true | false>
[Optional, default = false]
--first-result <int>
[Optional]
--max-results <int>
[Optional]
--filter <string>
[Optional]
--since <string>
[Optional]
--until <string>
[Optional]
MPA
mpa queue names
NAME
mpa queue names - List all Mail queue names
SYNOPSIS
mpa queue names
mpa repository delete
NAME
mpa repository delete - Delete Mail repository item
SYNOPSIS
mpa repository delete --mail-repository-url <url> --key <string>
OPTIONS
--mail-repository-url <url>
[Mandatory]
--key <string>
[Mandatory]
mpa queue delete
NAME
mpa queue delete - Delete a queued mail
SYNOPSIS
mpa queue delete --mail-queue-name <string> --field <sender | recipient | name> --search <string>
OPTIONS
--mail-queue-name <string>
[Mandatory]
--field <sender | recipient | name>
[Mandatory]
--search <string>
[Mandatory]
mpa repository keys
NAME
mpa repository keys - List all Mail repository keys
SYNOPSIS
mpa repository keys --mail-repository-url <url>
OPTIONS
--mail-repository-url <url>
[Mandatory]
mpa repository size
NAME
mpa repository size - Get Mail repository size
SYNOPSIS
mpa repository size --mail-repository-url <url>
OPTIONS
--mail-repository-url <url>
[Mandatory]
mpa queue list
NAME
mpa queue list - List all queued mails
SYNOPSIS
mpa queue list --mail-queue-name <string> [--first-result <int>] [--max-results <int>]
OPTIONS
--mail-queue-name <string>
[Mandatory]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
mpa queue get
NAME
mpa queue get - Get a queued mail
SYNOPSIS
mpa queue get --mail-queue-name <string> --mail-name <string> [--include-mime <true | false>] [--mime-output-file <file>]
OPTIONS
--mail-queue-name <string>
[Mandatory]
--mail-name <string>
[Mandatory]
--include-mime <true | false>
[Optional, default = false]
--mime-output-file <file>
[Optional]
mpa repository get
NAME
mpa repository get - Get Mail repository item
SYNOPSIS
mpa repository get --mail-repository-url <url> --key <string> [--include-mime <true | false>] [--mime-output-file <file>]
OPTIONS
--mail-repository-url <string>
[Mandatory]
--key <string>
[Mandatory]
--include-mime <true | false>
[Optional, default = false]
--mime-output-file <file>
[Optional]
mpa queue delete all
NAME
mpa queue delete all - Delete all queued mail
SYNOPSIS
mpa queue delete all --mail-queue-name <string>
OPTIONS
--mail-queue-name <string>
[Mandatory]
mpa repository delete all
NAME
mpa repository delete all - Delete all Mail repository items
SYNOPSIS
mpa repository delete all --mail-repository-url <url>
OPTIONS
--mail-repository-url <url>
[Mandatory]
mpa queue size
NAME
mpa queue size - Get number of queued mail
SYNOPSIS
mpa queue size --mail-queue-name <string>
OPTIONS
--mail-queue-name <string>
[Mandatory]
mpa repository urls
NAME
mpa repository urls - List all Mail repository URLs
SYNOPSIS
mpa repository urls
MTA
mta config main myhostname get
NAME
mta config main myhostname get - Get Postfix myhostname
SYNOPSIS
mta config main myhostname get
mta queue delete
NAME
mta queue delete - Delete Mail
SYNOPSIS
mta queue delete --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta config main internal-relay-hosts get
NAME
mta config main internal-relay-hosts get - Get Postfix internal relay hosts
SYNOPSIS
mta config main internal-relay-hosts get
mta relay-header-secret domain delete
NAME
mta relay-header-secret domain delete - Delete a Relay Header Secret from a domain
SYNOPSIS
mta relay-header-secret domain delete --domain <string> --id <string>
OPTIONS
--domain <string>
[Mandatory]
--id <string>
[Mandatory]
mta queue reschedule
NAME
mta queue reschedule - Reschedule deferred Mail
SYNOPSIS
mta queue reschedule --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta config main mynetworks get
NAME
mta config main mynetworks get - Get Postfix mynetworks
SYNOPSIS
mta config main mynetworks get
mta config main myhostname set
NAME
mta config main myhostname set - Set Postfix myhostname
SYNOPSIS
mta config main myhostname set --my-hostname <string>
OPTIONS
--my-hostname <string>
[Mandatory]
mta config main unverified-recipient-reject-code get
NAME
mta config main unverified-recipient-reject-code get - Set Postfix unverified recipient reject code
SYNOPSIS
mta config main unverified-recipient-reject-code get
mta map create
NAME
mta map create - Create a Postfix map file
SYNOPSIS
mta map create --type <btree | cidr | hash | pcre | regexp> --name <string>
OPTIONS
--type <btree | cidr | hash | pcre | regexp>
[Mandatory]
--name <string>
[Mandatory]
mta control stop
NAME
mta control stop - Stop Postfix
SYNOPSIS
mta control stop
mta config main relay-domains set
NAME
mta config main relay-domains set - Set Postfix relay domains
SYNOPSIS
mta config main relay-domains set --relay-domains <string-list>
OPTIONS
--relay-domains <string-list>
[Mandatory]
mta relay-header-secret global delete
NAME
mta relay-header-secret global delete - Delete a Relay Header Secret from the global properties
SYNOPSIS
mta relay-header-secret global delete --id <string>
OPTIONS
--id <string>
[Mandatory]
mta queue list
NAME
mta queue list - List MTA mail queue
SYNOPSIS
mta queue list [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
mta relay-header-secret domain add
NAME
mta relay-header-secret domain add - Add a Relay Header Secret to a domain
SYNOPSIS
mta relay-header-secret domain add --domain <string> --id <string> --relay-header-secret <string>
OPTIONS
--domain <string>
[Mandatory]
--id <string>
[Mandatory]
--relay-header-secret <string>
[Mandatory]
mta queue get
NAME
mta queue get - Get a queued mail
SYNOPSIS
mta queue get --queue-id <string> [--max-size <int>] [--mime-output-file <file>]
OPTIONS
--queue-id <string>
[Mandatory]
--max-size <int>
[Optional]
--mime-output-file <file>
[Optional]
mta control status
NAME
mta control status - Get Postfix status
SYNOPSIS
mta control status
mta config main unverified-recipient-reject-code set
NAME
mta config main unverified-recipient-reject-code set - Set Postfix unverified recipient reject code
SYNOPSIS
mta config main unverified-recipient-reject-code set --unverified-recipient-reject-code <int>
OPTIONS
--unverified-recipient-reject-code <int>
[Mandatory]
mta queue flush
NAME
mta queue flush - Flush MTA queue
SYNOPSIS
mta queue flush
mta config main message-size-limit get
NAME
mta config main message-size-limit get - Get Postfix message size limit
SYNOPSIS
mta config main message-size-limit get
mta config main internal-relay-hosts set
NAME
mta config main internal-relay-hosts set - Set Postfix internal relay hosts
SYNOPSIS
mta config main internal-relay-hosts set --relay-hosts <string>
OPTIONS
--relay-hosts <string>
[Mandatory]
mta control check running
NAME
mta control check running - Check if Postfix is running
SYNOPSIS
mta control check running
mta config main message-size-limit set
NAME
mta config main message-size-limit set - Set Postfix message size limit
SYNOPSIS
mta config main message-size-limit set --message-size-limit <int>
OPTIONS
--message-size-limit <int>
[Mandatory]
mta config main get
NAME
mta config main get - Get Postfix main config
SYNOPSIS
mta config main get
mta map set content
NAME
mta map set content - Set the Postfix map content
SYNOPSIS
mta map set content --type <btree | cidr | hash | pcre | regexp> --name <string> [--content <string>] [--file <file>]
OPTIONS
--type <btree | cidr | hash | pcre | regexp>
[Mandatory]
--name <string>
[Mandatory]
--content <string>
[Optional]
--file <file>
[Optional]
mta config main external-relay-hosts get
NAME
mta config main external-relay-hosts get - Get Postfix external relay hosts
SYNOPSIS
mta config main external-relay-hosts get
mta queue requeue
NAME
mta queue requeue - Requeue Mail
SYNOPSIS
mta queue requeue --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta config main external-relay-hosts set
NAME
mta config main external-relay-hosts set - Set Postfix external relay hosts
SYNOPSIS
mta config main external-relay-hosts set --relay-hosts <string>
OPTIONS
--relay-hosts <string>
[Mandatory]
mta config main relay-domains get
NAME
mta config main relay-domains get - Get Postfix relay domains
SYNOPSIS
mta config main relay-domains get
mta control restart
NAME
mta control restart - Restart Postfix
SYNOPSIS
mta control restart
mta config main smtp-helo-name get
NAME
mta config main smtp-helo-name get - Get Postfix SMTP HELO/EHLO name
SYNOPSIS
mta config main smtp-helo-name get
mta map delete
NAME
mta map delete - Delete a Postfix map file
SYNOPSIS
mta map delete --type <btree | cidr | hash | pcre | regexp> --name <string>
OPTIONS
--type <btree | cidr | hash | pcre | regexp>
[Mandatory]
--name <string>
[Mandatory]
mta relay-header-secret user delete
NAME
mta relay-header-secret user delete - Delete a Relay Header Secret from a user
SYNOPSIS
mta relay-header-secret user delete --email <string> --id <string>
OPTIONS
--email <string>
[Mandatory]
--id <string>
[Mandatory]
mta control start
NAME
mta control start - Start Postfix
SYNOPSIS
mta control start
mta queue bounce
NAME
mta queue bounce - Bounce Mail
SYNOPSIS
mta queue bounce --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta queue size
NAME
mta queue size - Get MTA queue size
SYNOPSIS
mta queue size
mta send mail
NAME
mta send mail - Send an email
SYNOPSIS
mta send mail --subject <string> --from <string>
[--text-body-base64 <string>]
[--html-body-base64 <string>]
[--sender <string>]
[--recipients <string-list>]
[--to <string-list>]
[--cc <string-list>]
[--mta-port <direct-delivery | mpa>]
[--attachment <file>]
OPTIONS
--subject <string>
[Mandatory]
--from <string>
[Mandatory]
--text-body-base64 <string>
[Optional]
--html-body-base64 <string>
[Optional]
--sender <string>
[Optional]
--recipients <string-list>
[Mandatory]
--to <string-list>
[Optional]
--cc <string-list>
[Optional]
--mta-port <direct-delivery | mpa>
[Optional, default = mpa]
--attachment <file>
[Optional]
mta relay-header-secret global add
NAME
mta relay-header-secret global add - Add a Relay Header Secret to the global properties
SYNOPSIS
mta relay-header-secret global add --id <string> --relay-header-secret <string>
OPTIONS
--id <string>
[Mandatory]
--relay-header-secret <string>
[Mandatory]
mta config main reject-unverified-recipient get
NAME
mta config main reject-unverified-recipient get - Get Postfix reject unverified recipient
SYNOPSIS
mta config main reject-unverified-recipient get
mta queue release
NAME
mta queue release - Release Mail
SYNOPSIS
mta queue release --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta config main set
NAME
mta config main set - Set Postfix main config
SYNOPSIS
mta config main set --config-file <file>
OPTIONS
--config-file <file>
[Mandatory]
mta queue hold
NAME
mta queue hold - Hold Mail
SYNOPSIS
mta queue hold --queue-ids <string-list>
OPTIONS
--queue-ids <string-list>
[Mandatory]
mta config main smtp-helo-name set
NAME
mta config main smtp-helo-name set - Set Postfix SMTP HELO/EHLO name
SYNOPSIS
mta config main smtp-helo-name set --smtp-helo-name <string>
OPTIONS
--smtp-helo-name <string>
[Mandatory]
mta config main mynetworks set
NAME
mta config main mynetworks set - Set Postfix mynetworks
SYNOPSIS
mta config main mynetworks set --my-networks <string-list>
OPTIONS
--my-networks <string-list>
[Mandatory]
mta relay-header-secret user add
NAME
mta relay-header-secret user add - Add a Relay Header Secret to a user
SYNOPSIS
mta relay-header-secret user add --email <string> --id <string> --relay-header-secret <string>
OPTIONS
--email <string>
[Mandatory]
--id <string>
[Mandatory]
--relay-header-secret <string>
[Mandatory]
mta map get content
NAME
mta map get content - Get the Postfix map content
SYNOPSIS
mta map get content --type <btree | cidr | hash | pcre | regexp> --name <string> [--output-file <file>]
OPTIONS
--type <btree | cidr | hash | pcre | regexp>
[Mandatory]
--name <string>
[Mandatory]
--output-file <file>
[Optional]
mta send mime
NAME
mta send mime - Send a raw MIME email
SYNOPSIS
mta send mime --recipients <string-list> --mime-file <file> [--sender <string>] [--mta-port <direct-delivery | mpa>]
OPTIONS
--recipients <string-list>
[Mandatory]
--mime-file <file>
[Mandatory]
--sender <string>
[Optional]
--mta-port <direct-delivery | mpa>
[Optional, default = mpa]
mta config main reject-unverified-recipient set
NAME
mta config main reject-unverified-recipient set - Set Postfix reject unverified recipient
SYNOPSIS
mta config main reject-unverified-recipient set [--reject-unverified-recipient <true | false>]
OPTIONS
--reject-unverified-recipient <true | false>
[Optional, default = false]
mta map list
NAME
mta map list - List all Postfix maps
SYNOPSIS
mta map list
MySQL
mysql variables get
NAME
mysql variables get - List MySQL/MariaDB variables
SYNOPSIS
mysql variables get
PGP
pgp keyring get sub-keys
NAME
pgp keyring get sub-keys - Get the sub keys of a master key
SYNOPSIS
pgp keyring get sub-keys --master-id <uuid>
OPTIONS
--master-id <uuid>
[Mandatory]
pgp user set signing key
NAME
pgp user set signing key - Set signing key for a user
SYNOPSIS
pgp user set signing key --email <string> --id <uuid>
OPTIONS
--email <string>
[Mandatory]
--id <uuid>
[Mandatory]
pgp keyring export secret-keys
NAME
pgp keyring export secret-keys - Export secret keys to a password protected keyring
SYNOPSIS
pgp keyring export secret-keys --ids <string-list> --password <string> --output-file <file>
OPTIONS
--ids <string-list>
[Mandatory]
--password <string>
[Mandatory]
--output-file <file>
[Mandatory]
pgp trust get all
NAME
pgp trust get all - List all PGP trust list entries
SYNOPSIS
pgp trust get all [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
pgp trust delete
NAME
pgp trust delete - Delete PGP trust list entry
SYNOPSIS
pgp trust delete --sha256-fingerprint <string>
OPTIONS
--sha256-fingerprint <string>
[Mandatory]
pgp keyring export public-keys
NAME
pgp keyring export public-keys - Export public keys to a keyring
SYNOPSIS
pgp keyring export public-keys --ids <string-list> --output-file <file>
OPTIONS
--ids List
[Mandatory]
--output-file <file>
[Mandatory]
pgp keyring search keys count
NAME
pgp keyring search keys count - Get the number of keys matching the search filter
SYNOPSIS
pgp keyring search keys count --search-value <string>
[--search-field <email | user-id | key-id | fingerprint>]
[--match <exact | like>]
[--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--pgp-key-type <master-key | sub-key | all>
OPTIONS
--search-value <string>
[Mandatory]
--search-field <email | user-id | key-id | fingerprint>
[Optional, default = email]
--match <exact | like>
[Optional, default = exact]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--pgp-key-type <master-key | sub-key | all>
[Optional, default = master-key]
pgp keyring generate secret-key
NAME
pgp keyring generate secret-key - Generate a secret key
SYNOPSIS
pgp keyring generate secret-key --email <string> --name <string>
[--key-type <rsa-1024 | rsa-2048 | rsa-3072 | rsa-4096 | ecc-nist-p-256 | ecc-nist-p-384 | ecc-nist-p-521 | ecc-brainpool-p-256 | ecc-brainpool-p-384 | ecc-brainpool-p-512 | ecc-secp256k1>]
[--publish-keys <true | false>]
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
--key-type <rsa-1024 | rsa-2048 | rsa-3072 | rsa-4096 | ecc-nist-p-256 | ecc-nist-p-384 | ecc-nist-p-521 | ecc-brainpool-p-256 | ecc-brainpool-p-384 | ecc-brainpool-p-512 | ecc-secp256k1>
[Optional, default = rsa-3072]
--publish-keys <true | false>
[Optional, default = false]
pgp is userid valid
NAME
pgp is userid valid - Checks if a userID is valid
SYNOPSIS
pgp is userid valid --id <uuid> --user-id <string>
OPTIONS
--id <uuid>
[Mandatory]
--user-id <string>
[Mandatory]
pgp domain get all signing keys
NAME
pgp domain get all signing keys - List signing keys for a domain
SYNOPSIS
pgp domain get all signing keys --domain <string>
OPTIONS
--domain <string>
[Mandatory]
pgp keyring get all count
NAME
pgp keyring get all count - Get the number of matching keys
SYNOPSIS
pgp keyring get all count [--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--pgp-key-type <master-key | sub-key | all>]
OPTIONS
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--pgp-key-type <master-key | sub-key | all>
[Optional, default = master-key]
pgp user get all encryption keys
NAME
pgp user get all encryption keys - List available encryption keys for a user
SYNOPSIS
pgp user get all encryption keys --email <string>
OPTIONS
--email <string>
[Mandatory]
pgp keyring search keys
NAME
pgp keyring search keys - Search for matching keys
SYNOPSIS
pgp keyring search keys --search-value <string>
[--search-field <email | user-id | key-id | fingerprint>]
[--match <exact | like> --expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--pgp-key-type <master-key | sub-key | all>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--search-value <string>
[Mandatory]
--search-field <email | user-id | key-id | fingerprint>
[Optional, default = email]
--match <exact | like>
[Optional, default = exact]
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--pgp-key-type <master-key | sub-key | all>
[Optional, default = master-key]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
pgp keyserver download
NAME
pgp keyserver download - Download keys from a remote key server
SYNOPSIS
pgp keyserver download --key-ids <string-list> [--auto-trust <true | false>]
OPTIONS
--key-ids <string-list>
[Mandatory]
--auto-trust <true | false>
[Optional, default = false]
pgp keyring import
NAME
pgp keyring import - Import keys from a PGP keyring
SYNOPSIS
pgp keyring import --file <file> [--password <string>] [--ignore-parsing-errors <true | false>]
OPTIONS
--file <file>
[Mandatory]
--password <string>
[Optional]
--ignore-parsing-errors <true | false>
[Optional, default = false]
pgp domain get signing key
NAME
pgp domain get signing key - Get signing key for a domain
SYNOPSIS
pgp domain get signing key --domain <string>
OPTIONS
--domain <string>
[Mandatory]
pgp user get signing key
NAME
pgp user get signing key - Get signing key for a user
SYNOPSIS
pgp user get signing key --email <string>
OPTIONS
--email <string>
[Mandatory]
pgp keyserver refresh
NAME
pgp keyserver refresh - Refresh keys from a remote key server
SYNOPSIS
pgp keyserver refresh --ids <string-list>
OPTIONS
--ids <string-list>
[Mandatory]
pgp keyring get public-key with fingerprint
NAME
pgp keyring get public-key with fingerprint - Get the public key with the given SHA256 fingerprint
SYNOPSIS
pgp keyring get public-key with fingerprint --sha256-fingerprint <string>
OPTIONS
--sha256-fingerprint <string>
[Mandatory]
pgp keyserver submit
NAME
pgp keyserver submit - Submit keys to a remote key server
SYNOPSIS
pgp keyserver submit --ids <string-list>
OPTIONS
--ids <string-list>
[Mandatory]
pgp trust set
NAME
pgp trust set - Set PGP trust list entry
SYNOPSIS
pgp trust set --sha256-fingerprint <string> [--status <trusted | untrusted>] [--include-subkeys <true | false>]
OPTIONS
--sha256-fingerprint <string>
[Mandatory]
--status <trusted | untrusted>
[Optional, default = trusted]
--include-subkeys <true | false>
[Optional, default = true]
pgp keyserver get config
NAME
pgp keyserver get config - Get remote key server config
SYNOPSIS
pgp keyserver get config
pgp user get all signing keys
NAME
pgp user get all signing keys - List signing keys for a user
SYNOPSIS
pgp user get all signing keys --email <string>
OPTIONS
--email <string>
[Mandatory]
pgp domain get all encryption keys
NAME
pgp domain get all encryption keys - List available encryption keys for a domain
SYNOPSIS
pgp domain get all encryption keys --domain <string>
OPTIONS
--domain <string>
[Mandatory]
pgp set email-and-domains
NAME
pgp set email-and-domains - Configure email and domains for a key
SYNOPSIS
pgp set email-and-domains --id <uuid> [--email-and-domains <string-list>]
OPTIONS
--id <uuid>
[Mandatory]
--email-and-domains <string-list>
[Optional]
pgp domain set signing key
NAME
pgp domain set signing key - Set signing key for a domain
SYNOPSIS
pgp domain set signing key --domain <string> --id <uuid>
OPTIONS
--domain <string>
[Mandatory]
--id <uuid>
[Mandatory]
pgp keyserver set config
NAME
pgp keyserver set config - Set remote key server config
SYNOPSIS
pgp keyserver set config --key-server-urls <url-list>
OPTIONS
--key-server-urls url-list
[Mandatory]
pgp keyring delete key
NAME
pgp keyring delete key - Delete key with the given id
SYNOPSIS
pgp keyring delete key --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
pgp trust get all count
NAME
pgp trust get all count - Get the number of PGP trust list entries
SYNOPSIS
pgp trust get all count
pgp is userid revoked
NAME
pgp is userid revoked - Checks if a userID is revoked
SYNOPSIS
pgp is userid revoked --id <uuid> --user-id <string>
OPTIONS
--id <uuid>
[Mandatory]
--user-id <string>
[Mandatory]
pgp revoke key
NAME
pgp revoke key - Revoke key with the given id
SYNOPSIS
pgp revoke key --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
pgp trust get
NAME
pgp trust get - Get PGP trust list entry
SYNOPSIS
pgp trust get --sha256-fingerprint <string>
OPTIONS
--sha256-fingerprint <string>
[Mandatory]
pgp keyring get all
NAME
pgp keyring get all - List all matching keys
SYNOPSIS
pgp keyring get all [--expired <match-all | match-unexpired-only | match-expired-only>]
[--missing-key-alias <allowed | not-allowed>]
[--pgp-key-type <master-key | sub-key | all>]
[--first-result <int>]
[--max-results <int>]
OPTIONS
--expired <match-all | match-unexpired-only | match-expired-only>
[Optional, default = match-all]
--missing-key-alias <allowed | not-allowed>
[Optional, default = allowed]
--pgp-key-type <master-key | sub-key | all>
[Optional, default = master-key]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
pgp keyring get public-key with id
NAME
pgp keyring get public-key with id - Get the public key with the given id
SYNOPSIS
pgp keyring get public-key with id --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
pgp keyserver search
NAME
pgp keyserver search - Search for keys on a remote key server
SYNOPSIS
pgp keyserver search --query <string> [--exact-match <true | false>] [--max-keys <int>]
OPTIONS
--query <string>
[Mandatory]
--exact-match <true | false>
[Optional, default = true]
--max-keys <int>
[Optional, default = 10]
Portal
portal otp send-secret-by-email
NAME
portal otp send-secret-by-email - Send the OTP client secret by email
SYNOPSIS
portal otp send-secret-by-email --recipient <string> --from <string>
[--sender <string>]
[--phone-number <string>]
[--recipient-enable-otp <true | false>]
[--password <string>]
OPTIONS
--recipient <string>
[Mandatory]
--from <string>
[Mandatory]
--sender <string>
[Optional]
--phone-number <string>
[Optional]
--recipient-enable-otp <true | false>
[Optional, default = true]
--password <string>
[Optional]
portal is-portal-user
NAME
portal is-portal-user - Returns true if the email address is registered on the portal and the password is set
SYNOPSIS
portal is-portal-user --email <string>
OPTIONS
--email <string>
[Mandatory]
Property
Tip
When you hover over a setting name, a tooltip displays the setting’s technical property name—the identifier you should use in property CLI commands.
property domain set file
NAME
property domain set file - Set domain property from a file
SYNOPSIS
property domain set file --domain <string> --name <string> --file <file>
OPTIONS
--domain <string>
[Mandatory]
--name <string>
[Mandatory]
--file <file>
[Mandatory]
property global set
NAME
property global set - Set global property
SYNOPSIS
property global set --name <string> --value <string>
OPTIONS
--name <string>
[Mandatory]
--value <string>
[Mandatory]
property descriptor
NAME
property descriptor - Get property descriptor for a property
SYNOPSIS
property descriptor --name <string>
OPTIONS
--name <string>
[Mandatory]
property user get
NAME
property user get - Get user property
SYNOPSIS
property user get --email <string> --name <string>
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
property global get multiple
NAME
property global get multiple - Get global properties
SYNOPSIS
property global get multiple --names <string-list>
OPTIONS
--names <string-list>
[Mandatory]
property available
NAME
property available - Get all supported properties
SYNOPSIS
property available [--category <string>] [--skip-invisible <true | false>] [--skip-unauthorized <true | false>]
OPTIONS
--category <string>
[Optional]
--skip-invisible <true | false>
[Optional, default = true]
--skip-unauthorized <true | false>
[Optional, default = true]
property user get value
NAME
property user get value - Get user property value
SYNOPSIS
property user get value --email <string> --name <string>
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
property global set file
NAME
property global set file - Set global property from a file
SYNOPSIS
property global set file --name <string> --file <file>
OPTIONS
--name <string>
[Mandatory]
--file <file>
[Mandatory]
property domain set
NAME
property domain set - Set domain property
SYNOPSIS
property domain set --domain <string> --name <string> --value <string>
OPTIONS
--domain <string>
[Mandatory]
--name <string>
[Mandatory]
--value <string>
[Mandatory]
property user reset
NAME
property user reset - Reset user property to its inherited value
SYNOPSIS
property user reset --email <string> --name <string>
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
property user set
NAME
property user set - Set user property
SYNOPSIS
property user set --email <string> --name <string> --value <string>
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
--value <string>
[Mandatory]
property global reset
NAME
property global reset - Reset global property to its inherited value
SYNOPSIS
property global reset --name <string>
OPTIONS
--name <string>
[Mandatory]
property available categories
NAME
property available categories - List all property categories
SYNOPSIS
property available categories [--skip-invisible <true | false>]
OPTIONS
--skip-invisible <true | false>
[Optional, default = true]
property user get multiple
NAME
property user get multiple - Get user properties
SYNOPSIS
property user get multiple --email <string> --names <string-list>
OPTIONS
--email <string>
[Mandatory]
--names <string-list>
[Mandatory]
property domain get value
NAME
property domain get value - Get domain property value
SYNOPSIS
property domain get value --domain <string> --name <string>
OPTIONS
--domain <string>
[Mandatory]
--name <string>
[Mandatory]
property global get
NAME
property global get - Get global property
SYNOPSIS
property global get --name <string>
OPTIONS
--name <string>
[Mandatory]
property domain reset
NAME
property domain reset - Reset domain property to its inherited value
SYNOPSIS
property domain reset --domain <string> --name <string>
OPTIONS
--domain <string>
[Mandatory]
--name <string>
[Mandatory]
property domain get multiple
NAME
property domain get multiple - Get domain properties
SYNOPSIS
property domain get multiple --domain <string> --names <string-list>
OPTIONS
--domain <string>
[Mandatory]
--names <string-list>
[Mandatory]
property user set file
NAME
property user set file - Set user property from a file
SYNOPSIS
property user set file --email <string> --name <string> --file <file>
OPTIONS
--email <string>
[Mandatory]
--name <string>
[Mandatory]
--file <file>
[Mandatory]
property domain get
NAME
property domain get - Get domain property
SYNOPSIS
property domain get --domain <string> --name <string>
OPTIONS
--domain <string>
[Mandatory]
--name <string>
[Mandatory]
property global get value
NAME
property global get value - Get global property value
SYNOPSIS
property global get value --name <string>
OPTIONS
--name <string>
[Mandatory]
Quarantine
quarantine get
NAME
quarantine get - Get quarantined email
SYNOPSIS
quarantine get --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
quarantine get mime
NAME
quarantine get mime - Get quarantined email content
SYNOPSIS
quarantine get mime --id <uuid> [--mime-output-file <file>]
OPTIONS
--id UUID
[Mandatory]
--mime-output-file <file>
[Optional]
quarantine get all
NAME
quarantine get all - List quarantined email
SYNOPSIS
quarantine get all [--first-result <int>] [--max-results <int>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
quarantine get count
NAME
quarantine get count - Get the number of quarantined emails
SYNOPSIS
quarantine get count
quarantine search count
NAME
quarantine search count - Search quarantined email count
SYNOPSIS
quarantine search count --search-field <id | message-id | subject | recipients | sender | from> --search-key <string>
OPTIONS
--search-field <id | message-id | subject | recipients | sender | from>
[Mandatory]
--search-key <string>
[Mandatory]
quarantine release
NAME
quarantine release - Release quarantined email
SYNOPSIS
quarantine release --id <uuid> --release-processor <default | encrypt | as-is>
OPTIONS
--id <uuid>
[Mandatory]
--release-processor <default | encrypt | as-is>
[Mandatory]
quarantine search
NAME
quarantine search - Search quarantined email
SYNOPSIS
quarantine search --search-field <id | message-id | subject | recipients | sender | from> --search-key <string>
[--first-result <int>]
[--max-results <int>]
OPTIONS
--search-field <id | message-id | subject | recipients | sender | from>
[Mandatory]
--search-key <string>
[Mandatory]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
quarantine delete
NAME
quarantine delete - Delete quarantined email
SYNOPSIS
quarantine delete --id <uuid>
OPTIONS
--id <uuid>
[Mandatory]
SMS
sms get all
NAME
sms get all - Get SMS messages
SYNOPSIS
sms get all [--sort-column <phonenumber | created | last-try>] [--sort-direction <asc | desc>] [--first-result <int>] [--max-results <int>]
OPTIONS
--sort-column <phonenumber | created | last-try>
[Optional, default = created]
--sort-direction <asc | desc>
[Optional, default = asc]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
sms delete
NAME
sms delete - Delete SMS message
SYNOPSIS
sms delete --ids <string-list>
OPTIONS
--ids <string-list>
[Mandatory]
sms delete all
NAME
sms delete all - Delete all SMS messages
SYNOPSIS
sms delete all
sms transports
NAME
sms transports - List all SMS transports
SYNOPSIS
sms transports
sms send
NAME
sms send - Send SMS message
SYNOPSIS
sms send --phone-number <string> --message <string>
OPTIONS
--phone-number <string>
[Mandatory]
--message <string>
[Mandatory]
sms get all count
NAME
sms get all count - Get number of SMS messages
SYNOPSIS
sms get all count
SwissSign
swisssign mpki get clients
NAME
swisssign mpki get clients - List clients for which the RA Operator can issue, revoke or pre validate DNS entries.
SYNOPSIS
swisssign mpki get clients
System
system ping
NAME
system ping - Send a ping command to the server and expect a pong back
SYNOPSIS
system ping
system set password
NAME
system set password - Set the back-end password
SYNOPSIS
system set password --password <string>
OPTIONS
--password <string>
[Mandatory]
system set base-url
NAME
system set base-url - Set the back-end base URL
SYNOPSIS
system set base-url --url <url>
OPTIONS
--url <url>
[Mandatory]
system get username
NAME
system get username - Get the back-end username
SYNOPSIS
system get username
system set username
NAME
system set username - Set the back-end username
SYNOPSIS
system set username --username <string>
OPTIONS
--username <string>
[Mandatory]
system service running
NAME
system service running - Returns true if a service is running
SYNOPSIS
system service running [--service <portal-backend | mta | imap>]
OPTIONS
--service <portal-backend | mta | imap>
[Optional, default = portal-backend]
system reset
NAME
system reset - Reset the cached http client connection
SYNOPSIS
system reset
system get base-url
NAME
system get base-url - Get the back-end base URL
SYNOPSIS
system get base-url
TLS
tls csr install certificate
NAME
tls csr install certificate - Make the certificate from the CSR the active TLS certificate
SYNOPSIS
tls csr install certificate --id <string>
OPTIONS
--id <string>
[Mandatory]
tls get active-certificate
NAME
tls get active-certificate - Returns the details of the active TLS certifcate
SYNOPSIS
tls get active-certificate
tls csr list
NAME
tls csr list - List all CSRs
SYNOPSIS
tls csr list
tls csr export certificate-chain
NAME
tls csr export certificate-chain - Export certificate chain and private key to a password protected PEM
SYNOPSIS
tls csr export certificate-chain --id <string> --export-password <string> [--output-file <file>]
OPTIONS
--id <string>
[Mandatory]
--export-password <string>
[Mandatory]
--output-file <file>
[Optional]
tls csr export pkcs10
NAME
tls csr export pkcs10 - Export PKCS#10 request with the given id
SYNOPSIS
tls csr export pkcs10 --id <string> [--output-file <file>]
OPTIONS
--id <string>
[Mandatory]
--output-file <file>
[Optional]
tls csr delete
NAME
tls csr delete - Delete CSR with the given id
SYNOPSIS
tls csr delete --id <string>
OPTIONS
--id <string>
[Mandatory]
tls csr import certificate-chain
NAME
tls csr import certificate-chain - Import certificate chain from a file
SYNOPSIS
tls csr import certificate-chain --certificates-file <file>
OPTIONS
--certificates-file <file>
[Mandatory]
tls pkcs12 import
NAME
tls pkcs12 import - Import a TLS certificate from a file
SYNOPSIS
tls pkcs12 import --pkcs12-file <file> [--key-store-password <string>]
OPTIONS
--pkcs12-file <file>
[Mandatory]
--key-store-password <string>
[Optional]
tls csr create
NAME
tls csr create - Create a CSR
SYNOPSIS
tls csr create --domains <string-list> --common-name <string>
[--email <string>]
[--organisation <string>]
[--organisational-unit <string>]
[--country-code <string>]
[--state <string>]
[--locality <string>]
[--given-name <string>]
[--surname <string>]
[--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>]
OPTIONS
--domains <string-list>
[Mandatory]
--common-name <string>
[Mandatory]
--email <string>
[Optional]
--organisation <string>
[Optional]
--organisational-unit <string>
[Optional]
--country-code <string>
[Optional]
--state <string>
[Optional]
--locality <string>
[Optional]
--given-name <string>
[Optional]
--surname <string>
[Optional]
--key-algorithm <rsa-2048 | rsa-3072 | rsa-4096 | secp521r1 | secp384r1 | secp256r1>
[Optional, default = secp256r1]
tls csr get
NAME
tls csr get - Get CSR with the given id
SYNOPSIS
tls csr get --id <string>
OPTIONS
--id <string>
[Mandatory]
Tool
tool html data-url encode
NAME
tool html data-url encode - Encodes the input to the form: data:[<media-type>][;base64],<data>
SYNOPSIS
tool html data-url encode --input-file <file> [--content-type <string>]
OPTIONS
--input-file <file>
[Mandatory]
--content-type <string>
[Optional]
User
user get all
NAME
user get all - List all users
SYNOPSIS
user get all [--sort-direction <asc | desc>] [--first-result <int>] [--max-results <int>]
OPTIONS
--sort-direction <asc | desc>
[Optional, default = asc]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
user get all count
NAME
user get all count - Get the number of users
SYNOPSIS
user get all count
user search
NAME
user search - Search for users
SYNOPSIS
user search --value <string> [--sort-direction <asc | desc>] [--first-result <int>] [--max-results <int>]
OPTIONS
--value <string>
[Mandatory]
--sort-direction <asc | desc>
[Optional, default = asc]
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
user delete
NAME
user delete - Delete user
SYNOPSIS
user delete --email <string>
OPTIONS
--email <string>
[Mandatory]
user get
NAME
user get - Get user details
SYNOPSIS
user get --email <string>
OPTIONS
--email <string>
[Mandatory]
user check
NAME
user check - Check if a user is configured
SYNOPSIS
user check --email <string>
OPTIONS
--email <string>
[Mandatory]
user add
NAME
user add - Add new user
SYNOPSIS
user add --email <string>
OPTIONS
--email <string>
[Mandatory]
user search count
NAME
user search count - Get the number of results for a search for users
SYNOPSIS
user search count --search <string>
OPTIONS
--search <string>
[Mandatory]
Webmail
webmail mailboxes list
NAME
webmail mailboxes list - Returns all mailboxes
SYNOPSIS
webmail mailboxes list [--first-result <int>] [--max-results <int>] [--filter <string>] [--orphaned-only <true | false>]
OPTIONS
--first-result <int>
[Optional, default = 0]
--max-results <int>
[Optional, default = 250]
--filter <string>
[Optional]
--orphaned-only <true | false>
[Optional, default = false]
webmail quota
NAME
webmail quota - Returns quota for a user
SYNOPSIS
webmail quota --email <string>
OPTIONS
--email <string>
[Mandatory]
webmail mailboxes delete
NAME
webmail mailboxes delete - Delete mailboxes
SYNOPSIS
webmail mailboxes delete --mailboxes <string-list>
OPTIONS
--mailboxes <string-list>
[Mandatory]
webmail mailboxes size
NAME
webmail mailboxes size - Returns the number of mailboxes
SYNOPSIS
webmail mailboxes size [--filter <string>] [--orphaned-only <true | false>]
OPTIONS
--filter <string>
[Optional]
--orphaned-only <true | false>
[Optional, default = false]