All Dovecot Doveadm Commands

acl add

Man Page	doveadm-acl(1)

Add ACL rights.

CLI

• Usage: doveadm acl add <mailbox> <id> <right> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to add to.
id	string	ID to add to.
right	array	ACL rights to add.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to add to.
id	string	ID to add to.
right	array	ACL rights to add.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl debug

Man Page	doveadm-acl(1)

Explain access rights for a mailbox/user.

CLI

• Usage: doveadm acl debug <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to query.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to query.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl delete

Man Page	doveadm-acl(1)

Delete an ACL entry.

CLI

• Usage: doveadm acl delete <mailbox> <id> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to delete.
id	string	ID to delete.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to delete.
id	string	ID to delete.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl get

Man Page	doveadm-acl(1)

Show ACLs.

CLI

• Usage: doveadm acl get [-m] <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-m	boolean
mailbox	string	Mailbox to query.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
matchMe	boolean
mailbox	string	Mailbox to query.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl recalc

Man Page	doveadm-acl(1)

Ensure shared mailboxes exist in ACL shared dictionary.

CLI

• Usage: doveadm acl recalc [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl remove

Man Page	doveadm-acl(1)

Remove ACL rights.

CLI

• Usage: doveadm acl remove <mailbox> <id> <right> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to remove rights from.
id	string	ID to remove.
right	array	ACL rights to remove.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to remove rights from.
id	string	ID to remove.
right	array	ACL rights to remove.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl rights

Man Page	doveadm-acl(1)

Show current ACL rights.

CLI

• Usage: doveadm acl rights <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to show.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to show.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

acl set

Man Page	doveadm-acl(1)

Replaces ACL rights.

CLI

• Usage: doveadm acl set <mailbox> <id> <right> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
mailbox	string	Mailbox to replace rights.
id	string	ID to replace.
right	array	ACL rights to replace.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
mailbox	string	Mailbox to replace rights.
id	string	ID to replace.
right	array	ACL rights to replace.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

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

• Usage: doveadm altmove [-r] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-r	boolean	Do a reverse move?
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
reverse	boolean	Do a reverse move?
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

auth cache flush

Man Page	doveadm-auth(1)
Return Values	Key Value entries

Flush authentication cache.

CLI

• Usage: doveadm auth cache flush [-a socket-path] <user>

Argument(s)	Type	Description
-a	string	Path to doveadm socket.
user	array	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
socketPath	string	Path to doveadm socket.
user	array	UID of user to apply operation to.

auth login

Man Page	doveadm-auth(1)

Test full login.

CLI

• Usage: doveadm auth login [-a auth-login-socket-path] [-m auth-master-socket-path] [-m sasl-mech] [-x auth-info] [-M master-user] <user> [password]

Argument(s)	Type	Description
-a	string
-m	string
-m	string
-x	array	Specifies additional conditions for the user command.
-M	string	Master user.
user	string	Login UID.
password	string	Login Password.

HTTP API

Parameter	Type	Description
authLoginSocketPath	string
authMasterSocketPath	string
saslMech	string
authInfo	array	Specifies additional conditions for the user command.
masterUser	string	Master user.
user	string	Login UID.
password	string	Login Password.

auth lookup

Man Page	doveadm-auth(1)

Perform a passdb lookup.

CLI

• Usage: doveadm auth lookup [-a socket-path] [-x auth-info] [-f field] <user>

Argument(s)	Type	Description
-a	string	Path to doveadm socket.
-x	array	Specifies additional conditions for the user command.
-f	string	Only return value of this field.
user	array	UID of user to query.

HTTP API

Parameter	Type	Description
socketPath	string	Path to doveadm socket.
authInfo	array	Specifies additional conditions for the user command.
field	string	Only return value of this field.
user	array	UID of user to query.

auth test

Man Page	doveadm-auth(1)

Test authentication for a user.

CLI

• Usage: doveadm auth test [-a socket-path] [-A sasl-mech] [-x auth-info] [-M master-user] <user> [password]

Argument(s)	Type	Description
-a	string	Path to doveadm socket.
-A	string
-x	array	Specifies additional conditions for the user command.
-M	string	Master user.
user	string	Login UID.
password	string	Login password.

HTTP API

Parameter	Type	Description
socketPath	string	Path to doveadm socket.
saslMech	string
authInfo	array	Specifies additional conditions for the user command.
masterUser	string	Master user.
user	string	Login UID.
password	string	Login password.

backup

Man Page	doveadm-sync(1)

CLI

• Usage: doveadm backup [-f] [-P] [-R] [-l lock-timeout] [-r rawlog] [-m mailbox] [-g mailbox-guid] [-n namespace] [-N] [-x exclude-mailbox] [-a all-mailbox] [-s state] [-t sync-since-time] [-e sync-until-time] [-O sync-flags] [-I sync-max-size] [-T timeout] [-d] [-E] <destination> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-f	boolean
-P	boolean
-R	boolean
-l	integer
-r	string
-m	string
-g	string
-n	array
-N	boolean
-x	array
-a	string
-s	string
-t	string
-e	string
-O	string
-I	string
-T	integer
-d	boolean
-E	boolean
destination	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
fullSync	boolean
purgeRemote	boolean
reverseSync	boolean
lockTimeout	integer
rawlog	string
mailbox	string
mailboxGuid	string
namespace	array
allNamespaces	boolean
excludeMailbox	array
allMailbox	string
state	string
syncSinceTime	string
syncUntilTime	string
syncFlags	string
syncMaxSize	string
timeout	integer
defaultDestination	boolean
legacyDsync	boolean
destination	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

cluster backend add

Man Page	doveadm-cluster-backend(1)

Adds a new backend to cluster. New backends are added in standby state. ID should not be used unless you are re-adding the same backend.

CLI

• Usage: doveadm cluster backend add [--self self] [--site site] [--id id] [--host host]

Argument(s)	Type	Description
--self		If set, targets the local site. (host will be ignored)
--site	string
--id	string
--host	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (host will be ignored)
site	string
id	string
host	string

cluster backend evacuate

Man Page	doveadm-cluster-backend(1)

Start moving all user groups to other backends. Will not wait for the moves to finish. Also sets the backend to standby and load factor to 0.

CLI

• Usage: doveadm cluster backend evacuate [--self self] [--host host]

Argument(s)	Type	Description
--self		If set, targets the local site. (host will be ignored)
--host	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (host will be ignored)
host	string

cluster backend list

Man Page	doveadm-cluster-backend(1)

Lists all backends in this cluster, including other sites.

CLI

• Usage: doveadm cluster backend list [--site site]

Argument(s)	Type	Description
--site	string	Only list specific site given.

HTTP API

Parameter	Type	Description
site	string	Only list specific site given.

cluster backend remove

Man Page	doveadm-cluster-backend(1)

Remove a backend from cluster.

CLI

• Usage: doveadm cluster backend remove [--self self] [--host host]

Argument(s)	Type	Description
--self		If set, targets the local site. (host will be ignored)
--host	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (host will be ignored)
host	string

cluster backend status

Man Page	doveadm-cluster-backend(1)

Shows the current status of the backend.

CLI

• Usage: doveadm cluster backend status [--self self] [--host host]

Argument(s)	Type	Description
--self		If set, targets the local site. (host will be ignored)
--host	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (host will be ignored)
host	string

cluster backend update

Man Page	doveadm-cluster-backend(1)

CLI

• Usage: doveadm cluster backend update [--self self] [--status status] [--load-factor load-factor] [--host host]

Argument(s)	Type	Description
--self		If set, targets the local site. (host will be ignored)
--status	string	online: Host is online and accepts connections standby: Host is online but is not usable for connections offline: Host is offline and will be turned back online when it recovers
--load-factor
--host	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (host will be ignored)
status	string	online: Host is online and accepts connections standby: Host is online but is not usable for connections offline: Host is offline and will be turned back online when it recovers
loadFactor
host	string

cluster geodb refresh

Man Page	doveadm-cluster-geodb(1)

Refreshes local caches from GeoDB. This is mainly intended for testing purposes. Usually this is not necessary to run, because cluster has been designed to work correctly even when caches aren’t up-to-date.

CLI

• Usage: doveadm cluster geodb refresh

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. This command must be run from a backend, not a proxy. For now this command is mainly used internally to finish user group moves.

CLI

• Usage: doveadm cluster group access <group>

Argument(s)	Type	Description
group	string

HTTP API

Parameter	Type	Description
group	string

cluster group list

Man Page	doveadm-cluster-group(1)

List all user groups.

CLI

• Usage: doveadm cluster group list [--site site] <mask>

Argument(s)	Type	Description
--site	string
mask	string

HTTP API

Parameter	Type	Description
site	string
mask	string

cluster group move

Man Page	doveadm-cluster-group(1)

Initiate a user group move, which finishes on background. The move is initialized by updating the moving and alt_backed_id fields in GeoDB. The next time a user in the group is accessed triggers the actual moving by the original backend. This user access is also automatically triggered by running doveadm cluster group access command in the group’s original backend.

CLI

• Usage: doveadm cluster group move <site> <group> <host>

Argument(s)	Type	Description
site	string
group	string
host	string

HTTP API

Parameter	Type	Description
site	string
group	string
host	string

cluster group status

Man Page	doveadm-cluster-group(1)

Display current status of a user group.

CLI

• Usage: doveadm cluster group status <site> <group>

Argument(s)	Type	Description
site	string
group	string

HTTP API

Parameter	Type	Description
site	string
group	string

cluster group update

Man Page	doveadm-cluster-group(1)

Updates group settings.

CLI

• Usage: doveadm cluster group update [--sticky-backend sticky-backend] [--sticky-users sticky-users] <site> <group>

Argument(s)	Type	Description
--sticky-backend		Whether this user group is eligible to be moved automatically to another backend in load balancing.
--sticky-users		Whether users in this user group are eligible to be moved automatically to other groups.
site	string
group	string

HTTP API

Parameter	Type	Description
stickyBackend		Whether this user group is eligible to be moved automatically to another backend in load balancing.
stickyUsers		Whether users in this user group are eligible to be moved automatically to other groups.
site	string
group	string

cluster kick

Man Page	doveadm-cluster-kick(1)

Disconnect user’s connections from Palomar

CLI

• Usage: doveadm cluster kick <user>

Argument(s)	Type	Description
user	string

HTTP API

Parameter	Type	Description
user	string

cluster site add

Man Page	doveadm-cluster-site(1)

Adds a new site to cluster. Load balancer is the host or IP address where another site’s proxy connects to do site to site connections. New sites are added in online state. UUID should not be used unless you are re-adding the same site.

CLI

• Usage: doveadm cluster site add [--id id] [--tag tag] [--load-balancer load-balancer] <name>

Argument(s)	Type	Description
--id	string
--tag	string
--load-balancer	string
name	string

HTTP API

Parameter	Type	Description
id	string
tag	string
loadBalancer	string
name	string

cluster site init

Man Page	doveadm-cluster-site(1)

Initialise site by creating user groups.

CLI

• Usage: doveadm cluster site init [--update update] [--self self] <name>

Argument(s)	Type	Description
--update
--self		If set, targets the local site. (name will be ignored)
name	string

HTTP API

Parameter	Type	Description
update
self		If set, targets the local site. (name will be ignored)
name	string

cluster site list

Man Page	doveadm-cluster-site(1)

List all sites.

CLI

• Usage: doveadm cluster site list

cluster site remove

Man Page	doveadm-cluster-site(1)

Remove a site. This currently has no safety checks, so be sure to remove first all of the site’s backends and remove it from all users’ preferred sites.

CLI

• Usage: doveadm cluster site remove <name>

Argument(s)	Type	Description
name	string

HTTP API

Parameter	Type	Description
name	string

cluster site status

Man Page	doveadm-cluster-site(1)

Site status.

CLI

• Usage: doveadm cluster site status <name>

Argument(s)	Type	Description
name	string

HTTP API

Parameter	Type	Description
name	string

cluster site update

Man Page	doveadm-cluster-site(1)

Update site status and load balancer.

CLI

• Usage: doveadm cluster site update [--self self] [--load-balancer load-balancer] [--status status] <name>

Argument(s)	Type	Description
--self		If set, targets the local site. (name will be ignored)
--load-balancer	string
--status	string
name	string

HTTP API

Parameter	Type	Description
self		If set, targets the local site. (name will be ignored)
loadBalancer	string
status	string
name	string

cluster tag create

Man Page	doveadm-cluster-tag(1)

Creates a new tag for cluster. UUID can be provided, if not, it will be generated.

CLI

• Usage: doveadm cluster tag create [--id id] <name>

Argument(s)	Type	Description
--id	string
name	string

HTTP API

Parameter	Type	Description
id	string
name	string

cluster tag delete

Man Page	doveadm-cluster-tag(1)

Delete a tag. This currently has no safety checks, so be sure to remove first all of the tag’s sites.

CLI

• Usage: doveadm cluster tag delete <id>

Argument(s)	Type	Description
id	string	Name or ID.

HTTP API

Parameter	Type	Description
id	string	Name or ID.

cluster tag list

Man Page	doveadm-cluster-tag(1)

List all tags.

CLI

• Usage: doveadm cluster tag list

cluster tag update

Man Page	doveadm-cluster-tag(1)

Change tag name.

CLI

• Usage: doveadm cluster tag update [--name name] <id>

Argument(s)	Type	Description
--name	string
id	string

HTTP API

Parameter	Type	Description
name	string
id	string

cluster user access

Man Page	doveadm-cluster-user(1)

Perform cluster lookup for the user (or users). Displays the host name or IP address of the backend which the user ended up. This command can be run from either a proxy or a backend. This command is also used internally to finish user moves.

CLI

• Usage: doveadm cluster user access [-i ip] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-i		Display backend's IP address rather than hostname.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
ip		Display backend's IP address rather than hostname.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

cluster user delete

Man Page	doveadm-cluster-user(1)

Deletes a record from GeoDB.

CLI

• Usage: doveadm cluster user delete <user>

Argument(s)	Type	Description
user	string

HTTP API

Parameter	Type	Description
user	string

cluster user move

Man Page	doveadm-cluster-user(1)

Initiates moving user to a different user group which will finish in background. The move is initialized by updating the moving_* fields in GeoDB. The next time the user is accessed triggers the actual moving by the original backend. This user access is also automatically triggered by running doveadm cluster user access command.

CLI

• Usage: doveadm cluster user move [--site site] <user> <group> [failover group]

Argument(s)	Type	Description
--site	string
user	string
group	string
failover-group	string

HTTP API

Parameter	Type	Description
site	string
user	string
group	string
failoverGroup	string

cluster user status

Man Page	doveadm-cluster-user(1)

Displays status information of a user.

CLI

• Usage: doveadm cluster user status <user>

Argument(s)	Type	Description
user	string

HTTP API

Parameter	Type	Description
user	string

compress connect

Man Page	doveadm-compress-connect(1)

Connects to a compression-enabled IMAP service.

CLI

• Usage: doveadm compress connect <host> [port]

Argument(s)	Type	Description
host	string	Hostname to connect to.
port	integer	Port to connect to.

HTTP API

Parameter	Type	Description
host	string	Hostname to connect to.
port	integer	Port to connect to.

copy

Man Page	doveadm-move(1)

Copy messages matching the given search query into another mailbox.

CLI

• Usage: doveadm copy <destination mailbox> [source user] [-u user] <query> [-A] [-S socket-path] [-F user-file]

Argument(s)	Type	Description
destination-mailbox	string
source-user	string
-u	string	UID of user to apply operation to.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
destinationMailbox	string
sourceUser	string
user	string	UID of user to apply operation to.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

deduplicate

Man Page	doveadm-deduplicate(1)

Expunge duplicated messages in mailboxes.

CLI

• Usage: doveadm deduplicate [-m] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-m	boolean	Deduplicate by Message-Id header. By default deduplication will be done by message GUIDs.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
byMsgId	boolean	Deduplicate by Message-Id header. By default deduplication will be done by message GUIDs.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

dict get

Man Page	doveadm-dict(1)

Get key value from configured dictionary.

CLI

• Usage: doveadm dict get [-u user] <dict uri> <key>

Argument(s)	Type	Description
-u	string	uid of user to query.
dict-uri	string	URI for dictionary to query.
key	string	Key to query.

HTTP API

Parameter	Type	Description
user	string	uid of user to query.
dictUri	string	URI for dictionary to query.
key	string	Key to query.

dict inc

Man Page	doveadm-dict(1)

Increase key value in dictionary.

CLI

• Usage: doveadm dict inc [-u user] <dict uri> <key> <difference>

Argument(s)	Type	Description
-u	string	uid of user to modify.
dict-uri	string	URI for dictionary to query.
key	string	Key to query.
difference	integer	The amount to increment.

HTTP API

Parameter	Type	Description
user	string	uid of user to modify.
dictUri	string	URI for dictionary to query.
key	string	Key to query.
difference	integer	The amount to increment.

dict iter

Man Page	doveadm-dict(1)

List keys in dictionary.

CLI

• Usage: doveadm dict iter [-u user] [-1] [-R] [-V] <dict uri> <prefix>

Argument(s)	Type	Description
-u	string	uid of user to query.
-1	boolean	List only exact matches?
-R	boolean	Do recursive searches?
-V	boolean	List keys that have no value set?
dict-uri	string	URI for dictionary to query.
prefix	string	Search only keys with this prefix.

HTTP API

Parameter	Type	Description
user	string	uid of user to query.
exact	boolean	List only exact matches?
recurse	boolean	Do recursive searches?
noValue	boolean	List keys that have no value set?
dictUri	string	URI for dictionary to query.
prefix	string	Search only keys with this prefix.

dict set

Man Page	doveadm-dict(1)

Set key value in configured dictionary.

CLI

• Usage: doveadm dict set [-u user] <dict uri> <key> <value>

Argument(s)	Type	Description
-u	string	uid of user to query.
dict-uri	string	URI for dictionary to query.
key	string	Key to query.
value	string	Value to set.

HTTP API

Parameter	Type	Description
user	string	uid of user to query.
dictUri	string	URI for dictionary to query.
key	string	Key to query.
value	string	Value to set.

dict unset

Man Page	doveadm-dict(1)

Unset key value in configured dictionary.

CLI

• Usage: doveadm dict unset [--user user] <dict uri> <key>

Argument(s)	Type	Description
--user	string	uid of user to query.
dict-uri	string	URI for dictionary to query.
key	string	Key to unset.

HTTP API

Parameter	Type	Description
user	string	uid of user to query.
dictUri	string	URI for dictionary to query.
key	string	Key to unset.

dump

Man Page	doveadm-dump(1)

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

CLI

• Usage: doveadm dump [-t type] <path> [args]

Argument(s)	Type	Description
-t	string
path	string
args	array

HTTP API

Parameter	Type	Description
type	string
path	string
args	array

exec

Man Page	doveadm-exec(1)

Execute commands from within /usr/libexec/dovecot.

CLI

• Usage: doveadm exec <binary> [args]

Argument(s)	Type	Description
binary	string	The name of an executable located in /usr/libexec/dovecot.
args	array	Options and arguments, which will be passed through to the binary.

HTTP API

Parameter	Type	Description
binary	string	The name of an executable located in /usr/libexec/dovecot.
args	array	Options and arguments, which will be passed through to the binary.

expunge

Man Page	doveadm-expunge(1)

Expunge messages matching given search query.

CLI

• Usage: doveadm expunge [-d] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-d	boolean	Delete mailbox if empty after expunge has been applied.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
deleteEmptyMailbox	boolean	Delete mailbox if empty after expunge has been applied.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

fetch

Man Page	doveadm-fetch(1)

Fetch mail data from user mailbox.

CLI

• Usage: doveadm fetch [--field field] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--field	array	Search fields to fetch.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
field	array	Search fields to fetch.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

flags add

Man Page	doveadm-flags(1)

Add flags to message(s).

CLI

• Usage: doveadm flags add [--flag flag] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--flag	array	List of flags to add.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
flag	array	List of flags to add.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

flags remove

Man Page	doveadm-flags(1)

Remove flags from message(s).

CLI

• Usage: doveadm flags remove [--flag flag] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--flag	array	List of flags to remove.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
flag	array	List of flags to remove.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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

• Usage: doveadm flags replace [--flag flag] <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--flag	array	List of flags to replace with.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
flag	array	List of flags to replace with.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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

• Usage: doveadm force resync [-f] [--mailbox-mask mailbox-mask] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-f	boolean
--mailbox-mask	string	Mask of mailboxes to fix.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
fsck	boolean
mailboxMask	string	Mask of mailboxes to fix.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

fs copy

Man Page	doveadm-fs(1)

Copy object in storage.

CLI

• Usage: doveadm fs copy <fs driver> <fs args> [--source-path source-path] [--destination-path destination-path]

Argument(s)	Type	Description
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
--source-path	string	Source object path.
--destination-path	string	Destination object path.

HTTP API

Parameter	Type	Description
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
sourcePath	string	Source object path.
destinationPath	string	Destination object path.

fs delete

Man Page	doveadm-fs(1)

Delete object from storage.

CLI

• Usage: doveadm fs delete [-R] [-n maxParallel] <fs driver> <fs args> <path>

Argument(s)	Type	Description
-R	boolean	Do recursive delete of path.
-n	integer	Max number of parallel workers.
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
recursive	boolean	Do recursive delete of path.
maxParallel	integer	Max number of parallel workers.
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fs get

Man Page	doveadm-fs(1)

Get object from storage.

CLI

• Usage: doveadm fs get <fs driver> <fs args> <path>

Argument(s)	Type	Description
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fs iter

Man Page	doveadm-fs(1)

List objects in fs path.

CLI

• Usage: doveadm fs iter [-C] [-O] <fs driver> <fs args> <path>

Argument(s)	Type	Description
-C	boolean
-O	boolean
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
noCache	boolean
objectIds	boolean
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fs iter-dirs

Man Page	doveadm-fs(1)

List folders in fs path.

CLI

• Usage: doveadm fs iter-dirs <fs driver> <fs args> <path>

Argument(s)	Type	Description
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fs metadata

Man Page	doveadm-fs(1)

CLI

• Usage: doveadm fs metadata <fs driver> <fs args> <path>

Argument(s)	Type	Description
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fs put

Man Page	doveadm-fs(1)

Store object in storage.

CLI

• Usage: doveadm fs put [-h hash] [-m metadata] <fs driver> <fs args> <input path> <path>

Argument(s)	Type	Description
-h	string
-m	array
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
input-path	string	Object input path.
path	string	Object path.

HTTP API

Parameter	Type	Description
hash	string
metadata	array
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
inputPath	string	Object input path.
path	string	Object path.

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

• Usage: doveadm fs stat <fs driver> <fs args> <path>

Argument(s)	Type	Description
fs-driver	string	Filesystem driver to use.
fs-args	string	Filesystem driver arguments to use.
path	string	Object path.

HTTP API

Parameter	Type	Description
fsDriver	string	Filesystem driver to use.
fsArgs	string	Filesystem driver arguments to use.
path	string	Object path.

fscache rescan

Man Page	doveadm-fscache(1)

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

CLI

• Usage: doveadm fscache rescan <path> [max age]

Argument(s)	Type	Description
path	string	Object path.
max-age	string	Files found with mtime older than this value are deleted from the cache.

HTTP API

Parameter	Type	Description
path	string	Object path.
maxAge	string	Files found with mtime older than this value are deleted from the cache.

fts check fast

Man Page	doveadm-fts(1)

Check FTS indexes for consistency. It performs a fast check using only information in local caches (fts.S, metacache).

CLI

• Usage: doveadm fts check fast [--refresh] [--print-mistmatches-only] <namespace> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--refresh	boolean	Refresh any necessary local caches for the command to run successfully. This can be used if the command otherwise fails with exit code 68.
--print-mistmatches-only	boolean	Print only mailboxes that have inconsistencies.
namespace	string	Namespace to process.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
refresh	boolean	Refresh any necessary local caches for the command to run successfully. This can be used if the command otherwise fails with exit code 68.
printMistmatchesOnly	boolean	Print only mailboxes that have inconsistencies.
namespace	string	Namespace to process.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

fts check full

Man Page	doveadm-fts(1)

CLI

• Usage: doveadm fts check full [--print-details] [--print-mistmatches-only] <namespace> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--print-details	boolean	Print also IMAP UID numbers and FTS triplet names for each email.
--print-mistmatches-only	boolean	Print only mailboxes that have inconsistencies.
namespace	string	Namespace to process.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
printDetails	boolean	Print also IMAP UID numbers and FTS triplet names for each email.
printMistmatchesOnly	boolean	Print only mailboxes that have inconsistencies.
namespace	string	Namespace to process.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

fts expand

Man Page	doveadm-fts(1)

Expand query using FTS.

CLI

• Usage: doveadm fts expand <query>

Argument(s)	Type	Description
query	search_query	Search query to apply.

HTTP API

Parameter	Type	Description
query	search_query	Search query to apply.

fts lookup

Man Page	doveadm-fts(1)

Search mail with FTS plugin.

CLI

• Usage: doveadm fts lookup <query>

Argument(s)	Type	Description
query	search_query	Search query to apply.

HTTP API

Parameter	Type	Description
query	search_query	Search query to apply.

fts optimize

Man Page	doveadm-fts(1)

Optimize FTS data.

CLI

• Usage: doveadm fts optimize <namespace>

Argument(s)	Type	Description
namespace	string	Namespace to optimize.

HTTP API

Parameter	Type	Description
namespace	string	Namespace to optimize.

fts rescan

Man Page	doveadm-fts(1)

Rebuild FTS indexes.

CLI

• Usage: doveadm fts rescan <namespace>

Argument(s)	Type	Description
namespace	string	Namespace to rebuild.

HTTP API

Parameter	Type	Description
namespace	string	Namespace to rebuild.

fts tokenize

Man Page	doveadm-fts(1)

Search mail with FTS plugin.

CLI

• Usage: doveadm fts tokenize [--language language] <text>

Argument(s)	Type	Description
--language	string
text	array	String to tokenize.

HTTP API

Parameter	Type	Description
language	string
text	array	String to tokenize.

import

Man Page	doveadm-import(1)

Import messages matching given search query.

CLI

• Usage: doveadm import [-U source-user] [-s] <source location> <dest parent-mailbox> <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-U	string	UID of user to apply import to.
-s	boolean	Newly created folders are also subscribed to.
source-location	string	Location of source mailboxes.
dest-parent-mailbox	string	Destination parent mailbox where to import.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
sourceUser	string	UID of user to apply import to.
subscribe	boolean	Newly created folders are also subscribed to.
sourceLocation	string	Location of source mailboxes.
destParentMailbox	string	Destination parent mailbox where to import.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

index

Man Page	doveadm-index(1)

Index user mailbox folder or folders.

CLI

• Usage: doveadm index [-q] [-n max-recent] <mailbox mask> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-q	boolean	Queue index operation for later execution.
-n	string	Max number of recent mails to index.
mailbox-mask	string	Mailbox search mask to apply indexing to.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
queue	boolean	Queue index operation for later execution.
maxRecent	string	Max number of recent mails to index.
mailboxMask	string	Mailbox search mask to apply indexing to.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

indexer add

Man Page	doveadm-indexer(1)

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

CLI

• Usage: doveadm indexer add [-h] [-n max-recent] <user> <mailbox>

Argument(s)	Type	Description
-h	boolean	Add request to the head of the queue.
-n	string	The maximum number of \Recent messages in the mailboxes.
user	string	The user to add.
mailbox	string	The mailbox to index.

HTTP API

Parameter	Type	Description
head	boolean	Add request to the head of the queue.
maxRecent	string	The maximum number of \Recent messages in the mailboxes.
user	string	The user to add.
mailbox	string	The mailbox to index.

indexer list

Man Page	doveadm-indexer(1)

List queued index requests.

CLI

• Usage: doveadm indexer list [user mask]

Argument(s)	Type	Description
user-mask	string	User Mask.

HTTP API

Parameter	Type	Description
userMask	string	User Mask.

indexer remove

Man Page	doveadm-indexer(1)

Remove index requests.

CLI

• Usage: doveadm indexer remove <user mask> [mailbox mask]

Argument(s)	Type	Description
user-mask	string	User Mask.
mailbox-mask	string	The mailbox mask to remove.

HTTP API

Parameter	Type	Description
userMask	string	User Mask.
mailboxMask	string	The mailbox mask to remove.

instance list

Man Page	doveadm-instance(1)

List Dovecot instances.

CLI

• Usage: doveadm instance list [-c] [name]

Argument(s)	Type	Description
-c	boolean
name	string

HTTP API

Parameter	Type	Description
showConfig	boolean
name	string

instance remove

Man Page	doveadm-instance(1)

Remove Dovecot instances.

CLI

• Usage: doveadm instance remove <name>

Argument(s)	Type	Description
name	string	The instance to remove.

HTTP API

Parameter	Type	Description
name	string	The instance to remove.

kick

Man Page	doveadm-kick(1)

Kick user.

CLI

• Usage: doveadm kick [-a socket-path] [-f passdb-field] [-h dest-host] <mask>

Argument(s)	Type	Description
-a	string	Anvil socket path.
-f	string	Passdb field.
-h	string	Destination host.
mask	array	UID mask.

HTTP API

Parameter	Type	Description
socketPath	string	Anvil socket path.
passdbField	string	Passdb field.
destHost	string	Destination host.
mask	array	UID mask.

log errors

Man Page	doveadm-log(1)

Fetch error logs.

CLI

• Usage: doveadm log errors [-c since]

Argument(s)	Type	Description
-c	integer	Only show errors since this point in time (UNIX timestamp).

HTTP API

Parameter	Type	Description
since	integer	Only show errors since this point in time (UNIX timestamp).

log find

Man Page	doveadm-log(1)

Show the location of logs.

CLI

• Usage: doveadm log find [log dir]

Argument(s)	Type	Description
log-dir	string	Specify directory where syslogd writes files.

HTTP API

Parameter	Type	Description
logDir	string	Specify directory where syslogd writes files.

log reopen

Man Page	doveadm-log(1)

Cause master process to reopen all log files.

CLI

• Usage: doveadm log reopen

log test

Man Page	doveadm-log(1)

Write a test message to the log files.

CLI

• Usage: doveadm log test

mailbox cache decision

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox cache decision [-a] [-f fieldstr] [-l last-used] [-d decision] <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-a	boolean
-f	string
-l	integer
-d	string
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
all	boolean
fieldstr	string
lastUsed	integer
decision	string
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox cache purge

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox cache purge <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox cache remove

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox cache remove <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox create

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox create [-s] [-g guid] <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
-g	string
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
subscriptions	boolean
guid	string
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox cryptokey export

Exports user or folder private keys.

CLI

• Usage: doveadm mailbox cryptokey export [-U] <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-U	boolean	Operate on user keypair only.
mailbox	string	Mailbox mask.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
userKey	boolean	Operate on user keypair only.
mailbox	string	Mailbox mask.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

mailbox cryptokey generate

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

• Usage: doveadm mailbox cryptokey generate [-U] [-R] [-f] <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-U	boolean	Operate on user keypair only.
-R	boolean	Re-encrypt all folder keys with current active user key
-f	boolean	Force keypair creation, normally keypair is only created if none found.
mailbox	string	Mailbox mask.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
userKeyOnly	boolean	Operate on user keypair only.
reEncryptBoxKeys	boolean	Re-encrypt all folder keys with current active user key
force	boolean	Force keypair creation, normally keypair is only created if none found.
mailbox	string	Mailbox mask.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

mailbox cryptokey list

List all keys for user or mailbox.

CLI

• Usage: doveadm mailbox cryptokey list [-U] <mailbox> [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-U	boolean	Operate on user keypair only.
mailbox	string	Mailbox mask.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
userKey	boolean	Operate on user keypair only.
mailbox	string	Mailbox mask.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

mailbox cryptokey password

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

CLI

• Usage: doveadm mailbox cryptokey password [-C] [-N] [-n new-password] [-O] [-o old-password] [-A] [-S socket-path] [-u user]

Argument(s)	Type	Description
-C	boolean	Clear password.
-N	boolean	Ask new password.
-n	string	New password.
-O	boolean	Ask old password.
-o	string	Old password.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.

HTTP API

Parameter	Type	Description
clearPassword	boolean	Clear password.
askNewPassword	boolean	Ask new password.
newPassword	string	New password.
askOldPassword	boolean	Ask old password.
oldPassword	string	Old password.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.

mailbox delete

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox delete [-e] [-s] [-r] [-Z] <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-e	boolean
-s	boolean
-r	boolean
-Z	boolean
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
requireEmpty	boolean
subscriptions	boolean
recursive	boolean
unsafe	boolean
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox list

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox list [-7] [-8] [-s] [mailbox mask] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-7	boolean
-8	boolean
-s	boolean
mailbox-mask	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mutf7	boolean
utf8	boolean
subscriptions	boolean
mailboxMask	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox metadata get

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox metadata get [-s] <mailbox> <key> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
mailbox	string
key	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allowEmptyMailboxName	boolean
mailbox	string
key	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox metadata list

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox metadata list [-s] [-p] <mailbox> <key prefix> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
-p	boolean
mailbox	string
key-prefix	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allowEmptyMailboxName	boolean
prependPrefix	boolean
mailbox	string
keyPrefix	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox metadata set

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox metadata set [-s] <mailbox> <key> <value> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
mailbox	string
key	string
value	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allowEmptyMailboxName	boolean
mailbox	string
key	string
value	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox metadata unset

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox metadata unset [-s] <mailbox> <key> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
mailbox	string
key	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allowEmptyMailboxName	boolean
mailbox	string
key	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox mutf7

CLI

• Usage: doveadm mailbox mutf7 [-7] [-8] <name>

Argument(s)	Type	Description
-7	boolean
-8	boolean
name	array

HTTP API

Parameter	Type	Description
toUtf8	boolean
fromUtf8	boolean
name	array

mailbox path

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox path [-t type] <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-t	string	Mailbox path type.
mailbox	array	Mailbox name to query.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
type	string	Mailbox path type.
mailbox	array	Mailbox name to query.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox rename

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox rename [-s] <mailbox> <new name> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-s	boolean
mailbox	string
new-name	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
subscriptions	boolean
mailbox	string
newName	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox status

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox status [-t] <field> <mailbox mask> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-t	boolean
-f	array
mailbox-mask	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
totalSum	boolean
field	array
mailboxMask	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox subscribe

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox subscribe <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox unsubscribe

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox unsubscribe <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
mailbox	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mailbox	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

mailbox update

Man Page	doveadm-mailbox(1)

CLI

• Usage: doveadm mailbox update [-g mailbox-guid] [-V uid-validity] [-N min-next-uid] [-R min-first-recent-uid] [-H min-highest-modseq] [-P min-highest-private-modseq] <mailbox> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-g	string
-V	integer
-N	integer
-R	integer
-H	integer
-P	integer
mailbox	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mailboxGuid	string
uidValidity	integer
minNextUid	integer
minFirstRecentUid	integer
minHighestModseq	integer
minHighestPrivateModseq	integer
mailbox	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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

• Usage: doveadm metacache clean [-x days] [-p min-priority] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-x	integer	Cleans metacache only if it hasn't been modified for this number of days
-p	integer	Minimum priority to clean. Values: 1..4
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
days	integer	Cleans metacache only if it hasn't been modified for this number of days
minPriority	integer	Minimum priority to clean. Values: 1..4
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

metacache flush

Man Page	doveadm-metacache(1)

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

CLI

• Usage: doveadm metacache flush [-p min-priority] [-i] <namespace> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-p	integer	Minimum priority to clean. Values: 1..4
-i	boolean	Only flush important changes.
namespace	string	Namespace.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
minPriority	integer	Minimum priority to clean. Values: 1..4
importantOnly	boolean	Only flush important changes.
namespace	string	Namespace.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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 expensive and long operation.

CLI

• Usage: doveadm metacache flushall [-a socket-path] [-f userdb-field] [-i] <mask>

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
-f	string	Use given field to match userdb. By default, it is username.
-i	boolean	Only flush important changes.
mask	string	User Mask.

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
userdbField	string	Use given field to match userdb. By default, it is username.
importantOnly	boolean	Only flush important changes.
mask	string	User Mask.

metacache list

Man Page

doveadm-metacache(1)

Return Values

Key Value username The primary username user_* Alternative usernames, if configured by returning user_* extra fields from userdb upload-within Value corresponds to the metacache_upload_interval setting dev-major Filesystem device where the user is located in. Filesystems are separately tracked by metacache, although currently support for multiple filesystems doesn't work as well as it could. Mainly the problem is that metacache_max_space globally applies to all the filesystems. dev-minor Filesystem device where the user is located in. Filesystems are separately tracked by metacache, although currently support for multiple filesystems doesn't work as well as it could. Mainly the problem is that metacache_max_space globally applies to all the filesystems. bytes-used(priority) Disk space used by index files of this priority in metacache. last-access(priority) UNIX timestamp of when the index files of this priority were last accessed in metacache. changes none means the index files have no changes done locally since they were downloaded. unimportant means there are some changes, but nothing that couldn't be regenerated if the server crashed. important means that there are changes that would be lost in case of a server crash. Currently the only important change is flag changes. * New mail deliveries aren't important, because the mail is immediately saved to object storage. In case of a crash the mails are listed in object storage and missing mails are added back to Dovecot indexes. The obox plugin also guarantees that the IMAP UID will be preserved in case of a crash. However, if a new mail delivery also sets a message flag (e.g. via Sieve script), then the change will be marked as important. An exception is the $HasAttachment and $HasNoAttachment flags, which are stored in the obox OID directly so they can be cheaply restored after a crash. last-service Last service that accessed this user. However, metacache clean and flush operations (via metacache-worker or doveadm) won't update this field. cleanup-weight Currently calculated weight when these indexes are cleaned up. Smaller numbers are cleaned up before larger numbers. Sorting the list output (with |sort -n) by this field will show the order in which the indexes would be cleaned. The cleanup weights are recalculated whenever the indexes are being accessed.

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

CLI

• Usage: doveadm metacache list [-a socket-path] [-f userdb-field] [-W] <mask>

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
-f	string	Use given field to match userdb. By default, it is username.
-W	boolean
mask	string	User Mask.

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
userdbField	string	Use given field to match userdb. By default, it is username.
warnMissingField	boolean
mask	string	User Mask.

metacache pull

Man Page	doveadm-metacache(1)

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

CLI

• Usage: doveadm metacache pull [-l] [-c] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-l	boolean	If set, pulling fails if there are newer bundles in storage than at source backend host.
-c	boolean	If set, metacache is cleaned for the user(s) that have been successfully pulled.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
latestOnly	boolean	If set, pulling fails if there are newer bundles in storage than at source backend host.
clean	boolean	If set, metacache is cleaned for the user(s) that have been successfully pulled.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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

• Usage: doveadm metacache refresh <namespace> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
namespace	string	Namespace.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
namespace	string	Namespace.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

metacache remove

Man Page	doveadm-metacache(1)

Remove metacache for matching users from metacache process.

CLI

• Usage: doveadm metacache remove [-a socket-path] <mask>

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
mask	string	User Mask.

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
mask	string	User Mask.

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

• Usage: doveadm metacache rescan [-a socket-path] <root_dir>

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
root_dir	string	The list of metacache root directories to rescan.

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
root_dir	string	The list of metacache root directories to rescan.

metacache status

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

Print statistics about metacache usage.

CLI

• Usage: doveadm metacache status [-a socket-path] [-b bytes] [--oldest-safe-timestamp] [--roots]

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
-b	integer	Force the result to be shown in bytes.
--oldest-safe-timestamp	boolean	Output the oldest safe timestamp. Any indexes accessed before that may or may not be corrupted, but indexes after that are known not to be corrupted.
--roots	boolean	Group the results by storage device instead of by time.

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
bytes	integer	Force the result to be shown in bytes.
oldestSafeTimestamp	boolean	Output the oldest safe timestamp. Any indexes accessed before that may or may not be corrupted, but indexes after that are known not to be corrupted.
roots	boolean	Group the results by storage device instead of by time.

metacache unpack

Man Page	doveadm-metacache(1)

Unpack given bundle from storage to a given directory.

CLI

• Usage: doveadm metacache unpack [--bundle-name bundle-name] <bundle> <destination directory>

Argument(s)	Type	Description
--bundle-name	string
bundle	string
destination-directory	string

HTTP API

Parameter	Type	Description
bundleName	string
bundle	string
destinationDirectory	string

metacache update userdb

Man Page	doveadm-metacache(1)

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

CLI

• Usage: doveadm metacache update userdb [-a socket-path] <username> <userdb field> <value>

Argument(s)	Type	Description
-a	string	Specify alternative metacache socket. Not usually needed.
username	string
userdb-field	string
value	string

HTTP API

Parameter	Type	Description
socketPath	string	Specify alternative metacache socket. Not usually needed.
username	string
userdbField	string
value	string

move

Man Page	doveadm-move(1)

CLI

• Usage: doveadm move <destination mailbox> [source user] [-u user] <query> [-A] [-S socket-path] [-F user-file]

Argument(s)	Type	Description
destination-mailbox	string
source-user	string
-u	string	UID of user to apply operation to.
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
destinationMailbox	string
sourceUser	string
user	string	UID of user to apply operation to.
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

nfs usercache clean

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

CLI

• Usage: doveadm nfs usercache clean [--min-age min-age] <path>

Argument(s)	Type	Description
--min-age	string
path	string	Root path to clean.

HTTP API

Parameter	Type	Description
minAge	string
path	string	Root path to clean.

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

• Usage: doveadm obox user delete [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

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

• Usage: doveadm obox user wait [--timeout timeout] [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
--timeout	integer	Timeout (in seconds)
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
timeout	integer	Timeout (in seconds)
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

penalty

Man Page	doveadm-penalty(1)

CLI

• Usage: doveadm penalty [-a socket-path] <netmask>

Argument(s)	Type	Description
-a	string	Anvil socket path.
netmask	string

HTTP API

Parameter	Type	Description
socketPath	string	Anvil socket path.
netmask	string

process status

Man Page	doveadm-process-status(1)

CLI

• Usage: doveadm process status [service]

Argument(s)	Type	Description
service	array

HTTP API

Parameter	Type	Description
service	array

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

• Usage: doveadm proxy kick [-a socket-path] [-f passdb-field] [-h dest-host] <mask>

Argument(s)	Type	Description
-a	string	Anvil socket path.
-f	string	Passdb field.
-h	string	Destination host.
mask	array	UID mask.

HTTP API

Parameter	Type	Description
socketPath	string	Anvil socket path.
passdbField	string	Passdb field.
destHost	string	Destination host.
mask	array	UID mask.

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

• Usage: doveadm proxy list [-a socket-path] [-1] [-f passdb-field] <mask>

Argument(s)	Type	Description
-a	string	Anvil socket path.
-1	boolean
-f	string	Passdb field.
mask	array	UID mask.

HTTP API

Parameter	Type	Description
socketPath	string	Anvil socket path.
separateConnections	boolean
passdbField	string	Passdb field.
mask	array	UID mask.

purge

Man Page	doveadm-purge(1)

CLI

• Usage: doveadm purge [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

pw

Man Page	doveadm-pw(1)

CLI

• Usage: doveadm pw [-l] [-p plaintext] [-r rounds] [-s scheme] [-t test-hash] [-u user] [-V]

Argument(s)	Type	Description
-l	boolean
-p	string
-r	integer
-s	string
-t	string
-u	string
-V	boolean

HTTP API

Parameter	Type	Description
list	boolean
plaintext	string
rounds	integer
scheme	string
testHash	string
user	string
reverseVerify	boolean

quota get

Man Page	doveadm-quota(1)

CLI

• Usage: doveadm quota get [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

quota recalc

Man Page	doveadm-quota(1)

CLI

• Usage: doveadm quota recalc [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

rebuild attachments

Man Page	doveadm-rebuild(1)

CLI

• Usage: doveadm rebuild attachments <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

reload

Man Page	doveadm(1)

CLI

• Usage: doveadm reload

save

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

CLI

• Usage: doveadm save [-m mailbox] [-U uid] [-g guid] [-r received-date] <file> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-m	string
-U	integer
-g	string
-r	string
file	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
mailbox	string
uid	integer
guid	string
receivedDate	string
file	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

search

Man Page	doveadm-search(1)

CLI

• Usage: doveadm search <query> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
query	search_query	Search query to apply.
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
query	search_query	Search query to apply.
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

service status

Man Page	doveadm-service-status(1)

CLI

• Usage: doveadm service status [service]

Argument(s)	Type	Description
service	array

HTTP API

Parameter	Type	Description
service	array

service stop

CLI

• Usage: doveadm service stop <service>

Argument(s)	Type	Description
service	array

HTTP API

Parameter	Type	Description
service	array

sieve activate

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve activate <scriptname> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
scriptname	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
scriptname	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve deactivate

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve deactivate [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve delete

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve delete [-a] <scriptname> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-a	boolean
scriptname	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
ignoreActive	boolean
scriptname	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve get

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve get <scriptname> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
scriptname	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
scriptname	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve list

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve list [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve put

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve put [-a] <scriptname> <file> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-a	boolean
scriptname	string
file	istream
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
activate	boolean
scriptname	string
file	istream
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sieve rename

Man Page	doveadm-sieve(1)

CLI

• Usage: doveadm sieve rename <oldname> <newname> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
oldname	string
newname	string
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
oldname	string
newname	string
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

sis find

CLI

• Usage: doveadm sis find <root dir> <hash>

Argument(s)	Type	Description
root-dir	string
hash	string

HTTP API

Parameter	Type	Description
rootDir	string
hash	string

stats add

Man Page	doveadm-stats(1)

CLI

• Usage: doveadm stats add [--exporter exporter] [--exporter-include exporter-include] [--description description] [--fields fields] [--group-by group-by] <name> <filter>

Argument(s)	Type	Description
--exporter	string
--exporter-include	string
--description	string
--fields	string
--group-by	string
name	string
filter	string

HTTP API

Parameter	Type	Description
exporter	string
exporterInclude	string
description	string
fields	string
groupBy	string
name	string
filter	string

stats dump

Man Page	doveadm-stats(1)

CLI

• Usage: doveadm stats dump [-s socketPath] [-r] [-f fields]

Argument(s)	Type	Description
-s	string
-r	boolean
-f	string

HTTP API

Parameter	Type	Description
socketPath	string
reset	boolean
fields	string

stats remove

Man Page	doveadm-stats(1)

CLI

• Usage: doveadm stats remove <name>

Argument(s)	Type	Description
name	string

HTTP API

Parameter	Type	Description
name	string

stats reopen

Man Page	doveadm-stats(1)

CLI

• Usage: doveadm stats reopen

stop

CLI

• Usage: doveadm stop

sync

Man Page	doveadm-sync(1)

CLI

• Usage: doveadm sync [-f] [-P] [-R] [-l lock-timeout] [-r rawlog] [-m mailbox] [-g mailbox-guid] [-n namespace] [-N] [-x exclude-mailbox] [-a all-mailbox] [-s state] [-t sync-since-time] [-e sync-until-time] [-O sync-flags] [-I sync-max-size] [-T timeout] [-d] [-E] [-1] <destination> [-A] [-S socket-path] [-u user] [-F user-file]

Argument(s)	Type	Description
-f	boolean
-P	boolean
-R	boolean
-l	integer
-r	string
-m	string
-g	string
-n	array
-N	boolean
-x	array
-a	string
-s	string
-t	string
-e	string
-O	string
-I	string
-T	integer
-d	boolean
-E	boolean
-1	boolean
destination	array
-A	boolean	Apply operation to all users.
-S	string	Path to doveadm socket.
-u	string	UID of user to apply operation to.
-F	string	A filename. If set, fetch usernames from file. One username per line.

HTTP API

Parameter	Type	Description
fullSync	boolean
purgeRemote	boolean
reverseSync	boolean
lockTimeout	integer
rawlog	string
mailbox	string
mailboxGuid	string
namespace	array
allNamespaces	boolean
excludeMailbox	array
allMailbox	string
state	string
syncSinceTime	string
syncUntilTime	string
syncFlags	string
syncMaxSize	string
timeout	integer
defaultDestination	boolean
legacyDsync	boolean
onewaySync	boolean
destination	array
allUsers	boolean	Apply operation to all users.
socketPath	string	Path to doveadm socket.
user	string	UID of user to apply operation to.
userFile	string	A filename. If set, fetch usernames from file. One username per line.

user

Man Page	doveadm-user(1)

CLI

• Usage: doveadm user [-a socket-path] [-x auth-info] [-f field] [-e expand-field] [-u] <user mask>

Argument(s)	Type	Description
-a	string	userdb socket path
-x	array
-f	string
-e	string
-u	boolean
user-mask	string	User Mask.

HTTP API

Parameter	Type	Description
socketPath	string	userdb socket path
authInfo	array
field	string
expandField	string
userdbOnly	boolean
userMask	string	User Mask.

who

Man Page	doveadm-who(1)

Show who is logged into the Dovecot server.

CLI

• Usage: doveadm who [-a socket-path] [-1] [-f passdb-field] <mask>

Argument(s)	Type	Description
-a	string	Anvil socket path.
-1	boolean
-f	string	Passdb field.
mask	array	UID mask.

HTTP API

Parameter	Type	Description
socketPath	string	Anvil socket path.
separateConnections	boolean
passdbField	string	Passdb field.
mask	array	UID mask.