Search K
Appearance
Appearance
doveadm [-o plugin/mail_crypt_private_password=password] [GLOBAL OPTIONS] mailbox cryptokey export|generate|list|password [options] [arguments]
Generate new keypair for user or folder. The new keypair is marked as active.
doveadm mailbox cryptokey can be used to manage user's cryptographic keys.
Global doveadm(1)
options:
Enables verbosity and debug messages.
Do not read any config file, just use defaults. The dovecot_storage_version
defaults to the latest version, but can be overridden with -o.
Preserve entire environment for doveadm, not just import_environment
.
Enables verbosity, including progress counter.
If using multiple Dovecot instances, choose the config file based on this instance name.
See instance_name
for more information.
Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.
Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.
Specifies the formatter for formatting the output. Supported formatters are:
Dovecot option, needed if you use password protected keys
If the -A option is present, the command will be performed for all users. Using this option in combination with system users from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID than the one configured with the first_valid_uid
setting.
When the SQL userdb module is used make sure that the iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Otherwise doveadm(1)
will be unable to iterate over all users.
Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.
Do not perform userdb lookup. Use the USER
environment variable to specify the username.
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname:port), in order to connect a remote host via a TCP socket.
This allows an administrator to execute doveadm(1)
mail commands through the given socket.
Run the command only for the given user. It's also possible to use '*' and '?' wildcards (e.g. -u *@example.org).
export [ -U ] | mailbox-mask
Exports user's or folder's keypair(s) in PEM format. If the keys are password protected, -o is needed.
generate [ -Rf [ -U ] | mailbox-mask*]*
Generates new keypair for user or folder. If you want to generate new user key and use it to secure your folder keys, use generate -u username -UR.
If you want to password-protect your key here, use -o.
list [ -U ] | mailbox-mask
List all keys for user or folder. No password is required.
password [ -N | -n password*]* [-O |-o password ] [ -C ]
Set, change or clear password from your user key.