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.

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.

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.

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.

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: 2.4.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: 2.4.0 separate-connections, passdb-field, and mask arguments added. Changed: 2.4.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: 2.4.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.