All Dovecot Doveadm Commands

acl add

Man Page	doveadm-acl(1)

Add ACL rights.

CLI

HTTP API

acl debug

Man Page	doveadm-acl(1)

Explain access rights for a mailbox/user.

CLI

HTTP API

acl delete

Man Page	doveadm-acl(1)

Delete an ACL entry.

CLI

HTTP API

acl get

Man Page	doveadm-acl(1)

Show ACLs.

CLI

HTTP API

acl recalc

Man Page	doveadm-acl(1)

Ensure shared mailboxes exist in ACL shared dictionary.

CLI

HTTP API

acl remove

Man Page	doveadm-acl(1)

Remove ACL rights.

CLI

HTTP API

acl rights

Man Page	doveadm-acl(1)

Show current ACL rights.

CLI

HTTP API

acl set

Man Page	doveadm-acl(1)

Replaces ACL rights.

CLI

HTTP API

altmove

Man Page	doveadm-altmove(1)

Move mails between primary and alternative mailbox storage locations.

WARNING

Applicable to mdbox and sdbox mailbox formats only.

CLI

HTTP API

auth cache flush

Man Page	doveadm-auth(1)

Flush authentication cache.

CLI

HTTP API

auth login

Man Page	doveadm-auth(1)

Test full login.

CLI

HTTP API

auth lookup

Man Page	doveadm-auth(1)

Perform a passdb lookup.

CLI

HTTP API

auth test

Man Page	doveadm-auth(1)

Test authentication for a user.

CLI

HTTP API

backup

Man Page	doveadm-sync(1)

CLI

HTTP API

cluster backend add

Man Page	doveadm-cluster-backend(1)

Adds a new backend to cluster.

CLI

HTTP API

cluster backend evacuate

Man Page	doveadm-cluster-backend(1)

Start moving all user groups to other backends.

CLI

HTTP API

cluster backend list

Man Page	doveadm-cluster-backend(1)

Lists all backends in this cluster, including other sites.

CLI

HTTP API

cluster backend remove

Man Page	doveadm-cluster-backend(1)

Remove a backend from cluster.

CLI

HTTP API

cluster backend status

Man Page	doveadm-cluster-backend(1)

Shows the current status of the backend.

CLI

HTTP API

cluster backend update

Man Page	doveadm-cluster-backend(1)

Update a cluster backend's status.

CLI

HTTP API

cluster geodb refresh

Man Page	doveadm-cluster-geodb(1)

Refreshes local caches from GeoDB

CLI

cluster group access

Man Page	doveadm-cluster-group(1)

Perform cluster lookup for the cluster_backend_test_username user as if it belonged to the specified group.

CLI

HTTP API

cluster group list

Man Page	doveadm-cluster-group(1)

List all user groups.

CLI

HTTP API

cluster group move

Man Page	doveadm-cluster-group(1)

Initiate a user group move.

CLI

HTTP API

cluster group status

Man Page	doveadm-cluster-group(1)

Display current status of a user group.

CLI

HTTP API

cluster group update

Man Page	doveadm-cluster-group(1)

Updates group settings.

CLI

HTTP API

cluster kick

Man Page	doveadm-cluster-kick(1)

Disconnect user’s connections from the cluster.

CLI

HTTP API

cluster site add

Man Page	doveadm-cluster-site(1)

Adds a new site to cluster.

CLI

HTTP API

cluster site init

Man Page	doveadm-cluster-site(1)

Initialise site by creating user groups.

CLI

HTTP API

cluster site list

Man Page	doveadm-cluster-site(1)

List all sites.

CLI

cluster site remove

Man Page	doveadm-cluster-site(1)

Remove a site.

CLI

HTTP API

cluster site status

Man Page	doveadm-cluster-site(1)

Site status.

CLI

HTTP API

cluster site update

Man Page	doveadm-cluster-site(1)

Update site status and load balancer.

CLI

HTTP API

cluster tag create

Man Page	doveadm-cluster-tag(1)

Creates a new tag for cluster.

CLI

HTTP API

cluster tag delete

Man Page	doveadm-cluster-tag(1)

Delete a tag.

CLI

HTTP API

cluster tag list

Man Page	doveadm-cluster-tag(1)

List all tags.

CLI

cluster tag update

Man Page	doveadm-cluster-tag(1)

Change tag name.

CLI

HTTP API

cluster user access

Man Page	doveadm-cluster-user(1)

Perform cluster lookup for the user (or users).

CLI

HTTP API

cluster user delete

Man Page	doveadm-cluster-user(1)

Deletes a record from GeoDB.

CLI

HTTP API

cluster user move

Man Page	doveadm-cluster-user(1)

Initiates moving user to a different user group.

CLI

HTTP API

cluster user status

Man Page	doveadm-cluster-user(1)

Displays status information of a user.

CLI

HTTP API

compress connect

Man Page	doveadm-compress-connect(1)

Connects to a compression-enabled IMAP service.

CLI

HTTP API

copy

Man Page	doveadm-copy(1)

Copy messages matching the given search query into another mailbox.

CLI

HTTP API

deduplicate

Man Page	doveadm-deduplicate(1)

Expunge duplicated messages in mailboxes.

CLI

HTTP API

dict get

Man Page	doveadm-dict(1)

Get key value from configured dictionary.

CLI

HTTP API

dict inc

Man Page	doveadm-dict(1)

Increase key value in dictionary.

CLI

HTTP API

dict iter

Man Page	doveadm-dict(1)

List keys in dictionary.

CLI

HTTP API

dict set

Man Page	doveadm-dict(1)

Set key value in configured dictionary.

CLI

HTTP API

dict unset

Man Page	doveadm-dict(1)

Unset key value in configured dictionary.

CLI

HTTP API

dump

Man Page	doveadm-dump(1)

Show contents of mailbox index/log files, in human readable format.

CLI

HTTP API

exec

Man Page	doveadm-exec(1)

Execute commands from within /usr/libexec/dovecot.

CLI

HTTP API

expunge

Man Page	doveadm-expunge(1)

Expunge messages matching given search query.

CLI

HTTP API

fetch

Man Page	doveadm-fetch(1)

Fetch mail data from user mailbox.

CLI

HTTP API

flags add

Man Page	doveadm-flags(1)

Add flags to message(s).

CLI

HTTP API

flags remove

Man Page	doveadm-flags(1)

Remove flags from message(s).

CLI

HTTP API

flags replace

Man Page	doveadm-flags(1)

Replace flags with another flag in message or messages. Replaces all current flags with the ones in the parameter list.

CLI

HTTP API

force resync

Man Page	doveadm-force-resync(1)

Under certain circumstances Dovecot may be unable to automatically solve problems with mailboxes. In such situations the force-resync command may be helpful. It tries to fix all problems. For sdbox and mdbox mailboxes the storage files will be also checked.

CLI

HTTP API

fs copy

Man Page	doveadm-fs(1)

Copy object in storage.

CLI

HTTP API

fs delete

Man Page	doveadm-fs(1)

Delete object from storage.

CLI

HTTP API

fs get

Man Page	doveadm-fs(1)

Get object from storage.

CLI

HTTP API

fs iter

Man Page	doveadm-fs(1)

List objects in fs path.

CLI

HTTP API

fs iter-dirs

Man Page	doveadm-fs(1)

List folders in fs path.

CLI

HTTP API

fs metadata

Man Page	doveadm-fs(1)

CLI

HTTP API

fs put

Man Page	doveadm-fs(1)

Store object in storage.

CLI

HTTP API

fs stat

Man Page	doveadm-fs(1)

Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.

CLI

HTTP API

fscache rescan

Man Page	doveadm-fscache(1)

Scans data in the fscache to recalculate the used storage space.

CLI

HTTP API

fts check fast

Man Page	doveadm-fts(1)

Check FTS indexes for consistency (fast checking).

CLI

HTTP API

fts check full

Man Page	doveadm-fts(1)

Check FTS indexes for consistency (full checking).

CLI

HTTP API

fts expand

Man Page	doveadm-fts(1)

Expand query using FTS.

CLI

HTTP API

fts lookup

Man Page	doveadm-fts(1)

Search mail with FTS plugin.

CLI

HTTP API

fts optimize

Man Page	doveadm-fts(1)

Optimize FTS data.

CLI

HTTP API

fts rescan

Man Page	doveadm-fts(1)

Rebuild FTS indexes.

CLI

HTTP API

fts tokenize

Man Page	doveadm-fts(1)

Search mail with FTS plugin.

CLI

HTTP API

import

Man Page	doveadm-import(1)

Import messages matching given search query.

CLI

HTTP API

index

Man Page	doveadm-index(1)

Index user mailbox folder or folders.

CLI

HTTP API

indexer add

Man Page	doveadm-indexer(1)

Add indexing request for the given user and the mailbox to the indexer queue.

CLI

HTTP API

indexer list

Man Page	doveadm-indexer(1)

List queued index requests.

CLI

HTTP API

indexer remove

Man Page	doveadm-indexer(1)

Remove index requests.

CLI

HTTP API

instance list

Man Page	doveadm-instance(1)

List Dovecot instances.

CLI

HTTP API

instance remove

Man Page	doveadm-instance(1)

Remove Dovecot instances.

CLI

HTTP API

kick

Man Page	doveadm-kick(1)

Kick user.

CLI

HTTP API

log errors

Man Page	doveadm-log(1)

Fetch error logs.

CLI

HTTP API

log find

Man Page	doveadm-log(1)

Show the location of logs.

CLI

HTTP API

log reopen

Man Page	doveadm-log(1)

Cause master process to reopen all log files.

CLI

log test

Man Page	doveadm-log(1)

Write a test message to the log files.

CLI

mailbox cache decision

Man Page	doveadm-mailbox(1)

List or change caching decisions for field(s).

CLI

HTTP API

mailbox cache purge

Man Page	doveadm-mailbox(1)

Purge the dovecot.index.cache file.

CLI

HTTP API

mailbox cache remove

Man Page	doveadm-mailbox(1)

Remove matching mails from the cache.

CLI

HTTP API

mailbox create

Man Page	doveadm-mailbox(1)

Create mailboxes.

CLI

HTTP API

mailbox cryptokey export

Man Page	doveadm-mailbox-cryptokey(1)

Exports user or folder private keys.

CLI

HTTP API

mailbox cryptokey generate

Man Page	doveadm-mailbox-cryptokey(1)

Generate new keypair for user or folder.

To generate new active user key and re-encrypt all your keys with it can be done with

doveadm mailbox cryptokey generate -u username -UR

This can be used to generate new user keypair and re-encrypt and create folder keys.

Note

You must provide a password if you want to generate password-protected keypair right away. You can also use doveadm mailbox cryptokey password to secure it.

CLI

HTTP API

mailbox cryptokey list

Man Page	doveadm-mailbox-cryptokey(1)

List all keys for user or mailbox.

CLI

HTTP API

mailbox cryptokey password

Man Page	doveadm-mailbox-cryptokey(1)

Sets, changes or clears password for user's private key.

CLI

HTTP API

mailbox delete

Man Page	doveadm-mailbox(1)

Delete mailboxes.

CLI

HTTP API

mailbox list

Man Page	doveadm-mailbox(1)

Get list of existing mailboxes.

CLI

HTTP API

mailbox metadata get

Man Page	doveadm-mailbox(1)

Get metadata for a mailbox.

CLI

HTTP API

mailbox metadata list

Man Page	doveadm-mailbox(1)

List metadata for a mailbox.

CLI

HTTP API

mailbox metadata set

Man Page	doveadm-mailbox(1)

Set metadata for a mailbox.

CLI

HTTP API

mailbox metadata unset

Man Page	doveadm-mailbox(1)

Unset metadata for a mailbox.

CLI

HTTP API

mailbox mutf7

Man Page	doveadm-mailbox(1)

Convert mailbox names from mUTF-7 to UTF-8.

CLI

HTTP API

mailbox path

Man Page	doveadm-mailbox(1)

Returns filesystem paths for the mailboxes.

CLI

HTTP API

mailbox rename

Man Page	doveadm-mailbox(1)

Rename mailbox.

CLI

HTTP API

mailbox status

Man Page	doveadm-mailbox(1)

Show status of mailboxes.

CLI

HTTP API

mailbox subscribe

Man Page	doveadm-mailbox(1)

Subscribe to mailboxes.

CLI

HTTP API

mailbox unsubscribe

Man Page	doveadm-mailbox(1)

Unsubscribe from mailboxes.

CLI

HTTP API

mailbox update

Man Page	doveadm-mailbox(1)

Set internal mailbox metadata.

CLI

HTTP API

metacache clean

Man Page	doveadm-metacache(1)

Cleans old indexes for given users. If the indexes have not been flushed yet this command will fail.

CLI

HTTP API

metacache flush

Man Page	doveadm-metacache(1)

Flushes metacache to storage for the given user(s).

CLI

HTTP API

metacache flushall

Man Page	doveadm-metacache(1)

Flush all matching users to storage. If no mask is specified, everything is flushed.

WARNING

This can be an expensive and long operation.

CLI

HTTP API

metacache list

Man Page	doveadm-metacache(1)

List current metacache for matching users. If no mask is specified, lists all users’ metacache.

CLI

HTTP API

metacache pull

Man Page	doveadm-metacache(1)

Pull all metacache for given user(s) from source backend host.

CLI

HTTP API

metacache refresh

Man Page	doveadm-metacache(1)

Force refreshing metacache for the given user(s) the next time it’s opened. The refresh is done for the user root index and all the folders.

CLI

HTTP API

metacache remove

Man Page	doveadm-metacache(1)

Remove metacache for matching users from metacache process.

CLI

HTTP API

metacache rescan

Man Page	doveadm-metacache(1)

Triggers an explicit metacache rescan, which makes sure the disk space usage tracked by metacache process matches what really exists on filesystem.

CLI

HTTP API

metacache status

Man Page	doveadm-metacache(1)
Changes	Added: 3.0.1 oldest-safe-timestamp argument added.

Print statistics about metacache usage.

CLI

HTTP API

metacache unpack

Man Page	doveadm-metacache(1)

Unpack given bundle from storage to a given directory.

CLI

HTTP API

metacache update userdb

Man Page	doveadm-metacache(1)

Update alternative usernames (user_* fields) in doveadm metacache list output.

CLI

HTTP API

move

Man Page	doveadm-move(1)

CLI

HTTP API

nfs usercache clean

Cleans user's cache under root path for given age.

CLI

HTTP API

obox user delete

Man Page	doveadm-obox(1)

Delete user data from storage, Cassandra and local caches (metacache and fscache).

If deletion is not possible as the index is still open in another process, fail with exit code 65.

CLI

HTTP API

obox user wait

Man Page	doveadm-obox(1)

Wait until there are no more sessions (imap, lmtp, etc.) accessing the user.

If there are still sessions after timeout is reached, fail with exit code 65.

CLI

HTTP API

penalty

Man Page	doveadm-penalty(1)

CLI

HTTP API

process status

Man Page	doveadm-process-status(1)

CLI

HTTP API

proxy kick

Man Page	doveadm-proxy(1)
Changes	Changed: 3.0.0 host argument has been changed to dest-host. user argument has been changed to mask.

Kick user.

CLI

HTTP API

proxy list

Man Page	doveadm-proxy(1)
Changes	Added: 3.0.0 separate-connections, passdb-field, and mask arguments added. Changed: 3.0.0 The response format has changed. Dovecot now returns different formats based on the value of separate-connections. If separate-connections is true, pid, ip, dest_ip, and list of alt_username_fields (from anvil) is returned.

Show who is logged into the Dovecot server.

CLI

HTTP API

purge

Man Page	doveadm-purge(1)

Remove all messages with refcount=0 from a user's mail storage.

CLI

HTTP API

pw

Man Page	doveadm-pw(1)

Generate password hashes.

CLI

HTTP API

quota get

Man Page	doveadm-quota(1)

Display current quota usage.

CLI

HTTP API

quota recalc

Man Page	doveadm-quota(1)

Recalculate current quota usage.

CLI

HTTP API

rebuild attachments

Man Page	doveadm-rebuild(1)

Rebuild attachment detection information in index.

CLI

HTTP API

reload

Man Page	doveadm(1)

Reload Dovecot configuration.

CLI

save

Man Page	doveadm-save(1)
Changes	Added: 3.0.0 received-date, uid, and gid arguments added.

Save messages to a mailbox.

CLI

HTTP API

search

Man Page	doveadm-search(1)

Find matching messages in mailbox.

CLI

HTTP API

service status

Man Page	doveadm-service-status(1)

Show information about Dovecot services.

CLI

HTTP API

service stop

Man Page	doveadm-service-stop(1)

Stop Dovecot services.

CLI

HTTP API

sieve activate

Man Page	doveadm-sieve(1)

Mark active Sieve script.

CLI

HTTP API

sieve deactivate

Man Page	doveadm-sieve(1)

Deactivate Sieve script.

CLI

HTTP API

sieve delete

Man Page	doveadm-sieve(1)

Delete Sieve scripts.

CLI

HTTP API

sieve get

Man Page	doveadm-sieve(1)

Retrieve a Sieve script.

CLI

HTTP API

sieve list

Man Page	doveadm-sieve(1)

List Sieve scripts.

CLI

HTTP API

sieve put

Man Page	doveadm-sieve(1)

Add Sieve script to storage.

CLI

HTTP API

sieve rename

Man Page	doveadm-sieve(1)

Rename Sieve script.

CLI

HTTP API

sis find

CLI

HTTP API

stats add

Man Page	doveadm-stats(1)

Add metrics to statistics.

CLI

HTTP API

stats dump

Man Page	doveadm-stats(1)

Output statistics.

CLI

HTTP API

stats remove

Man Page	doveadm-stats(1)

Remove metrics from statistics.

CLI

HTTP API

stats reopen

Man Page	doveadm-stats(1)

Reopen file exporter files.

CLI

stop

Man Page	doveadm(1)

Stop Dovecot.

CLI

sync

Man Page	doveadm-sync(1)

Dovecot's mailbox synchronization utility.

CLI

HTTP API

user

Man Page	doveadm-user(1)

Lookup user in Dovecot's userdbs.

CLI

HTTP API

who

Man Page	doveadm-who(1)

Show who is logged into the Dovecot server.

CLI

HTTP API