Do a reverse move.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-altmove", "text": "Move mails between primary and alternative mailbox storage locations.
\n\n", "man_link": "doveadm-altmove(1)",
"usage": "altmove [-r] Mailbox to add to.
\n" }, { "example": "acl_id", "flag": "id", "param": "id", "type": "string", "text": "ID to add to.
\n" }, { "example": [ "r", "w" ], "flag": "right", "param": "right", "type": "array", "text": "ACL rights to add.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Add ACL rights.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl add Mailbox to query.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Explain access rights for a mailbox/user.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl debug Mailbox to delete.
\n" }, { "example": "acl_id", "flag": "id", "param": "id", "type": "string", "text": "ID to delete.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Delete an ACL entry.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl delete Mailbox to query.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Show ACLs.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl get [-m] Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Ensure shared mailboxes exist in ACL shared dictionary.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl recalc [-A] [-S socket-path] [-u user]",
"http_cmd": "aclRecalc"
},
"acl remove": {
"args": [
{
"example": "INBOX",
"flag": "mailbox",
"param": "mailbox",
"type": "string",
"text": "Mailbox to remove rights from.
\n" }, { "flag": "id", "param": "id", "type": "string", "text": "ID to remove.
\n" }, { "flag": "right", "param": "right", "type": "array", "text": "ACL rights to remove.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Remove ACL rights.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl remove Mailbox to show.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Show current ACL rights.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl rights Mailbox to replace rights.
\n" }, { "example": "acl_id", "flag": "id", "param": "id", "type": "string", "text": "ID to replace.
\n" }, { "example": [ "r", "w" ], "flag": "right", "param": "right", "type": "array", "text": "ACL rights to replace.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "man": "doveadm-acl", "plugin": "acl", "text": "Replaces ACL rights.
\n", "man_link": "doveadm-acl(1)",
"usage": "acl set Path to doveadm socket.
\n" }, { "example": "username_?", "flag": "user-mask", "param": "userMask", "type": "array", "text": "user-mask of users to apply operation to.
\n" } ], "response": { "example": { "entries": 1 }, "text": "| Key | \nDescription | \n
|---|---|
entries | \nThe number of cache entries flushed. | \n
Flush authentication cache.
\n", "man_link": "doveadm-auth(1)",
"usage": "auth cache flush [-a socket-path] Specifies additional conditions for the user command.
\n" }, { "example": "masteruser", "flag": "-M", "param": "masterUser", "type": "string", "text": "Master user.
\n" }, { "example": "username", "flag": "user", "param": "user", "type": "string", "text": "Login UID.
\n" }, { "example": "password", "flag": "password", "param": "password", "type": "string", "text": "Login Password.
\n" } ], "man": "doveadm-auth", "text": "Test full login.
\n", "man_link": "doveadm-auth(1)",
"usage": "auth login [-a auth-login-socket-path] [-m auth-master-socket-path] [-A sasl-mech] [-x auth-info] [-M master-user] Path to doveadm socket.
\n" }, { "flag": "-x", "param": "authInfo", "type": "array", "text": "Specifies additional conditions for the user command.
\n" }, { "example": "fieldname", "flag": "-f", "param": "field", "type": "string", "text": "Only return value of this field.
\n" }, { "example": "username", "flag": "user", "param": "user", "type": "array", "text": "UID of user to query.
\n" } ], "man": "doveadm-auth", "text": "Perform a passdb lookup.
\n", "man_link": "doveadm-auth(1)",
"usage": "auth lookup [-a socket-path] [-x auth-info] [-f field] Path to doveadm socket.
\n" }, { "example": "PLAIN", "flag": "-A", "param": "saslMech", "type": "string" }, { "flag": "-x", "param": "authInfo", "type": "array", "text": "Specifies additional conditions for the user command.
\n" }, { "example": "masteruser", "flag": "-M", "param": "masterUser", "type": "string", "text": "Master user.
\n" }, { "example": "username", "flag": "user", "param": "user", "type": "string", "text": "Login UID.
\n" }, { "example": "password", "flag": "password", "param": "password", "type": "string", "text": "Login password.
\n" } ], "man": "doveadm-auth", "text": "Test authentication for a user.
\n", "man_link": "doveadm-auth(1)",
"usage": "auth test [-a socket-path] [-A sasl-mech] [-x auth-info] [-M master-user] Full sync.
\n" }, { "flag": "-P", "param": "purgeRemote", "type": "boolean", "text": "Purge destination after sync.
\n" }, { "flag": "-R", "param": "reverseSync", "type": "boolean", "text": "Do a reverse sync.
\n" }, { "example": 60, "flag": "-l", "param": "lockTimeout", "type": "integer", "text": "Lock timeout for the user (in seconds).
\n" }, { "example": "rawlog_name", "flag": "-r", "param": "rawlog", "type": "string", "text": "Write rawlog to this file.
\n" }, { "example": "INBOX", "flag": "-m", "param": "mailbox", "type": "string", "text": "Sync only this mailbox.
\n" }, { "example": "mailbox_guid", "flag": "-g", "param": "mailboxGuid", "type": "string", "text": "Sync only this mailbox GUID.
\n" }, { "example": [ "namespace" ], "flag": "-n", "param": "namespace", "type": "array", "text": "Sync only these namespaces.
\n" }, { "flag": "-N", "param": "allNamespaces", "type": "boolean", "text": "Sync all namespaces.
\n" }, { "example": [ "excluded_mailbox" ], "flag": "-x", "param": "excludeMailbox", "type": "array", "text": "Exclude these mailbox names/masks.
\n" }, { "example": "VirtualAll", "flag": "-a", "param": "allMailbox", "type": "string", "text": "The name of the virtual All mailbox.
\n" }, { "example": "state_string", "flag": "-s", "param": "state", "type": "string", "text": "State string of last dsync run.
\n" }, { "example": "7 days", "flag": "-t", "param": "syncSinceTime", "type": "string", "text": "Sync since timestamp.
\nAllowable formats:
\nSync until timestamp.
\nAllowable formats:
\nSync only mails that have the specified flag. If the flag name begins with\n-, sync all mails except the ones with the specified flag.
Skip any mails larger than the specified size.
\nFormat: size
\n" }, { "example": 60, "flag": "-T", "param": "timeout", "type": "integer", "text": "Timeout (in seconds).
\n" }, { "flag": "-d", "param": "defaultDestination", "type": "boolean", "text": "Use the default destination.
\n" }, { "flag": "-E", "param": "legacyDsync", "type": "boolean", "text": "Use legacy dsync.
\n" }, { "flag": "destination", "param": "destination", "type": "array", "text": "The synchronized destination. See doveadm-sync(1) for options.
Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-sync", "text": "Dovecot's mailbox synchronization utility.
\nThis command cannot be used safely via API by untrusted users.
\n", "man_link": "doveadm-sync(1)",
"usage": "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] Hostname to connect to.
\n" }, { "example": "123", "flag": "port", "param": "port", "type": "integer", "text": "Port to connect to.
\n" } ], "man": "doveadm-compress-connect", "text": "Connects to a compression-enabled IMAP service.
\n", "man_link": "doveadm-compress-connect(1)",
"usage": "compress connect Show all settings.
\n" }, { "flag": "-C", "param": "C", "type": "boolean", "text": "TODO (check full config).
\n" }, { "example": "/etc/dovecot/dovecot.conf", "flag": "-c", "param": "c", "type": "string", "text": "Read configuration from this file.
\n" }, { "flag": "-d", "param": "d", "type": "boolean", "text": "Show setting's default value.
\n" }, { "flag": "-F", "param": "F", "type": "boolean", "text": "Show the configuration in a filter-based format.
\n" }, { "example": "protocol=imap", "flag": "-f", "param": "f", "type": "string", "text": "Apply filters to limit output.
\n" }, { "flag": "-h", "param": "h", "type": "boolean", "text": "Hide the setting's name.
\n" }, { "flag": "-I", "param": "I", "type": "boolean", "text": "TODO (dump config import).
\n" }, { "flag": "-N", "param": "N", "type": "boolean", "text": "Show settings with non-default values and explicitly set default values.
\n" }, { "flag": "-n", "param": "n", "type": "boolean", "text": "Show only settings with non-default values.
\n" }, { "flag": "-P", "param": "P", "type": "boolean", "text": "Show passwords and other sensitive values.
\n" }, { "flag": "-s", "param": "s", "type": "boolean", "text": "Show hidden settings.
\n" }, { "flag": "-U", "param": "U", "type": "boolean", "text": "Ignore unknown settings.
\n" }, { "flag": "-w", "param": "w", "type": "boolean", "text": "TODO (hide obsolete warnings).
\n" }, { "flag": "-x", "param": "x", "type": "boolean", "text": "Expand variables and show file contents.
\n" }, { "example": "namespace", "flag": "section_name", "param": "section_name", "type": "string", "text": "Show only the configuration of these section names.
\n" }, { "example": "mailbox", "flag": "setting_name", "param": "setting_name", "type": "string", "text": "Show only the configuration of these setting names.
\n" } ], "man": "doveconf", "text": "Read and parse Dovecot's configuration files.
\n", "man_link": "doveconf(1)",
"usage": "config [-a] [-C] [-c c] [-d] [-F] [-f f] [-h] [-I] [-N] [-n] [-P] [-s] [-U] [-w] [-x] [section_name] [setting_name]",
"http_cmd": "config"
},
"copy": {
"args": [
{
"example": "Test",
"flag": "destination-mailbox",
"param": "destinationMailbox",
"type": "string",
"text": "The destination mailbox.
\n" }, { "example": "sourceuser", "flag": "source-user", "param": "sourceUser", "type": "string", "text": "Apply the search query to this user's mail_location.
For CLI use, this is specified by adding the keyword user followed by\nthe source user name, e.g., user sourceuser.
Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-copy", "text": "Copy messages matching the given search query into another mailbox.
\n", "man_link": "doveadm-copy(1)",
"usage": "copy Deduplicate by Message-Id header. By default deduplication will be done by message GUIDs.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-deduplicate", "text": "Expunge duplicated messages in mailboxes.
\n", "man_link": "doveadm-deduplicate(1)",
"usage": "deduplicate [-m] uid of user to query.
\n" }, { "example": "dict_label", "flag": "dict-uri", "param": "dictUri", "type": "string", "text": "URI for dictionary to query.
\n" }, { "example": "example_key", "flag": "key", "param": "key", "type": "string", "text": "Key to query.
\n" } ], "man": "doveadm-dict", "text": "Get key value from configured dictionary.
\n", "man_link": "doveadm-dict(1)",
"usage": "dict get [-u user] uid of user to modify.
\n" }, { "example": "dict_label", "flag": "dict-uri", "param": "dictUri", "type": "string", "text": "URI for dictionary to query.
\n" }, { "example": "example_key", "flag": "key", "param": "key", "type": "string", "text": "Key to query.
\n" }, { "example": 1, "flag": "difference", "param": "difference", "type": "integer", "text": "The amount to increment.
\n" } ], "man": "doveadm-dict", "text": "Increase key value in dictionary.
\n", "man_link": "doveadm-dict(1)",
"usage": "dict inc [-u user] uid of user to query.
\n" }, { "flag": "-1", "param": "exact", "type": "boolean", "text": "List only exact matches.
\n" }, { "flag": "-R", "param": "recurse", "type": "boolean", "text": "Do recursive searches.
\n" }, { "flag": "-V", "param": "noValue", "type": "boolean", "text": "List keys that have no value set.
\n" }, { "example": "dict_label", "flag": "dict-uri", "param": "dictUri", "type": "string", "text": "URI for dictionary to query.
\n" }, { "example": "testprefix", "flag": "prefix", "param": "prefix", "type": "string", "text": "Search only keys with this prefix.
\n" } ], "man": "doveadm-dict", "text": "List keys in dictionary.
\n", "man_link": "doveadm-dict(1)",
"usage": "dict iter [-u user] [-1] [-R] [-V] uid of user to query.
\n" }, { "example": "dict_label", "flag": "dict-uri", "param": "dictUri", "type": "string", "text": "URI for dictionary to query.
\n" }, { "example": "example_key", "flag": "key", "param": "key", "type": "string", "text": "Key to query.
\n" }, { "example": "value", "flag": "value", "param": "value", "type": "string", "text": "Value to set.
\n" } ], "man": "doveadm-dict", "text": "Set key value in configured dictionary.
\n", "man_link": "doveadm-dict(1)",
"usage": "dict set [-u user] uid of user to query.
\n" }, { "example": "dict_label", "flag": "dict-uri", "param": "dictUri", "type": "string", "text": "URI for dictionary to query.
\n" }, { "example": "example_key", "flag": "key", "param": "key", "type": "string", "text": "Key to unset.
\n" } ], "man": "doveadm-dict", "text": "Unset key value in configured dictionary.
\n", "man_link": "doveadm-dict(1)",
"usage": "dict unset [--user user] The type of file to be dumped.
\n" }, { "example": "/path/to/file", "flag": "path", "param": "path", "type": "string", "text": "Path to the file specified by the type argument.
\n" }, { "example": [ "uid=123" ], "flag": "args", "param": "args", "type": "array", "text": "Type specific arguments.
\n" } ], "man": "doveadm-dump", "text": "Show contents of mailbox index/log files, in human readable format.
\n", "man_link": "doveadm-dump(1)",
"usage": "dump [-t type] The name of an executable located in /usr/libexec/dovecot.
Options and arguments, which will be passed through to the binary.
\n" } ], "man": "doveadm-exec", "text": "Execute commands from within /usr/libexec/dovecot.
doveadm-exec(1)",
"usage": "exec Delete mailbox if empty after expunge has been applied.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-expunge", "text": "Expunge messages matching given search query.
\n", "man_link": "doveadm-expunge(1)",
"usage": "expunge [-d] Search fields to fetch.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-fetch", "text": "Fetch mail data from user mailbox.
\n", "man_link": "doveadm-fetch(1)",
"usage": "fetch [--field field] List of flags to add.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-flags", "text": "Add flags to message(s).
\n", "man_link": "doveadm-flags(1)",
"usage": "flags add [--flag flag] List of flags to remove.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-flags", "text": "Remove flags from message(s).
\n", "man_link": "doveadm-flags(1)",
"usage": "flags remove [--flag flag] List of flags to replace with.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-flags", "text": "Replace flags with another flag in message or messages. Replaces all current flags with the ones in the parameter list.
\n", "man_link": "doveadm-flags(1)",
"usage": "flags replace [--flag flag] Mask of mailboxes to fix.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-force-resync", "text": "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.
\n", "man_link": "doveadm-force-resync(1)",
"usage": "force resync [-f] [--mailbox-mask mailbox-mask] [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "forceResync"
},
"fs copy": {
"args": [
{
"flag": "filter-name",
"param": "filterName",
"type": "string",
"text": "Configuration filter name to use.
\n" }, { "flag": "--source-path", "param": "sourcePath", "type": "string", "text": "Source object path.
\n" }, { "flag": "--destination-path", "param": "destinationPath", "type": "string", "text": "Destination object path.
\n" } ], "man": "doveadm-fs", "text": "Copy object in storage.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs copy Do recursive delete of path.
\n" }, { "flag": "-n", "param": "maxParallel", "type": "integer", "text": "Max number of parallel workers.
\n" }, { "flag": "filter-name", "param": "filterName", "type": "string", "text": "Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "Delete object from storage.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs delete [-R] [-n max-parallel] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "Get object from storage.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs get Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "List objects in fs path.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs iter [-C] [-O] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "List folders in fs path.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs iter-dirs Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "man_link": "doveadm-fs(1)",
"usage": "fs metadata Configuration filter name to use.
\n" }, { "flag": "input-path", "param": "inputPath", "type": "string", "text": "Object input path.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "Store object in storage.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs put [-h hash] [-m metadata] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" } ], "man": "doveadm-fs", "text": "Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.
\n", "man_link": "doveadm-fs(1)",
"usage": "fs stat Search query to apply.
\n" } ], "man": "doveadm-fts", "plugin": "fts", "text": "Expand query using FTS.
\n", "man_link": "doveadm-fts(1)",
"usage": "fts expand Search query to apply.
\n" } ], "man": "doveadm-fts", "plugin": "fts", "text": "Search mail with FTS plugin.
\n", "man_link": "doveadm-fts(1)",
"usage": "fts lookup Namespace to optimize.
\n" } ], "man": "doveadm-fts", "plugin": "fts", "text": "Optimize FTS data.
\n", "man_link": "doveadm-fts(1)",
"usage": "fts optimize Namespace to rebuild.
\n" } ], "man": "doveadm-fts", "plugin": "fts", "text": "Rebuild FTS indexes.
\n", "man_link": "doveadm-fts(1)",
"usage": "fts rescan String to tokenize.
\n" } ], "man": "doveadm-fts", "plugin": "fts", "text": "Search mail with FTS plugin.
\n", "man_link": "doveadm-fts(1)",
"usage": "fts tokenize [--language language] A list of mailbox masks to check.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "man": "doveadm-fts", "plugin": "fts-flatcurve", "flags": 3, "text": "Run a simple check on Dovecot Xapian databases, and attempt to fix basic\nerrors (it is the same checking done by the xapian-check command with the\n-F command-line option).
For each mailbox that has FTS data, it outputs the following key/value fields:
\n| Key | \nValue | \n
|---|---|
| mailbox | \nThe human-readable mailbox name. (key is hidden) | \n
| guid | \nThe GUID of the mailbox. | \n
| errors | \nThe number of errors reported by the Xapian library. | \n
| shards | \nThe number of index shards processed. | \n
doveadm-fts(1)",
"usage": "fts flatcurve check A list of mailbox masks to remove.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "man": "doveadm-fts", "plugin": "fts-flatcurve", "flags": 3, "text": "Removes all FTS data for a mailbox.
\n", "response": { "example": [ { "mailbox": "INBOX", "guid": "guid_string" } ], "text": "For each mailbox removed, it outputs the following key/value fields:
\n| Key | \nValue | \n
|---|---|
| mailbox | \nThe human-readable mailbox name. (key is hidden) | \n
| guid | \nThe GUID of the mailbox. | \n
doveadm-fts(1)",
"usage": "fts flatcurve remove A list of mailbox masks to rotate.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "man": "doveadm-fts", "plugin": "fts-flatcurve", "flags": 3, "text": "Triggers an FTS index rotation for a mailbox.
\n", "response": { "example": [ { "mailbox": "INBOX", "guid": "guid_string" } ], "text": "For each mailbox rotated, it outputs the following key/value fields:
\n| Key | \nValue | \n
|---|---|
| mailbox | \nThe human-readable mailbox name. (key is hidden) | \n
| guid | \nThe GUID of the mailbox. | \n
doveadm-fts(1)",
"usage": "fts flatcurve rotate A list of mailbox masks to process.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "man": "doveadm-fts", "plugin": "fts-flatcurve", "flags": 3, "text": "Returns FTS data for a mailbox.
\n", "response": { "example": [ { "mailbox": "INBOX", "guid": "guid_string", "last_uid": 123, "messages": 2, "shards": 1, "version": 1 } ], "text": "For each mailbox that has FTS data, it outputs the following key/value fields:
\n| Key | \nValue | \n
|---|---|
| mailbox | \nThe human-readable mailbox name. (key is hidden) | \n
| guid | \nThe GUID of the mailbox. | \n
| last_uid | \nThe last UID indexed in the mailbox. | \n
| messages | \nThe number of messages indexed in the mailbox. | \n
| shards | \nThe number of index shards. | \n
| version | \nThe (Dovecot internal) version of the FTS data. | \n
doveadm-fts(1)",
"usage": "fts flatcurve stats The command/group to show the man page of.
\n" } ], "text": "Provide doveadm usage information.
\n", "usage": "help [command]", "http_cmd": "help" }, "import": { "args": [ { "example": "sourceuser", "flag": "-U", "param": "sourceUser", "type": "string", "text": "UID of user to apply import to.
\n" }, { "flag": "-s", "param": "subscribe", "type": "boolean", "text": "Newly created folders are also subscribed to.
\n" }, { "example": "maildir:/backup/Maildir", "flag": "source-location", "param": "sourceLocation", "type": "string", "text": "Location of source mailbox.
\n" }, { "example": "backup", "flag": "dest-parent-mailbox", "param": "destParentMailbox", "type": "string", "text": "Destination parent mailbox where to import.
\n" }, { "example": [ "mailbox", "INBOX/myfoldertoo", "savedbefore", "since", "30d" ], "flag": "query", "param": "query", "type": "search_query", "text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-import", "text": "Import messages matching given search query.
\n", "man_link": "doveadm-import(1)",
"usage": "import [-U source-user] [-s] Queue index operation for later execution.
\n" }, { "example": 10, "flag": "-n", "param": "maxRecent", "type": "string", "text": "Max number of recent mails to index.
\n" }, { "example": "INBOX", "flag": "mailbox-mask", "param": "mailboxMask", "type": "string", "text": "Mailbox search mask to apply indexing to.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-index", "text": "Index user mailbox folder or folders.
\n", "man_link": "doveadm-index(1)",
"usage": "index [-q] [-n max-recent] Add request to the head of the queue.
\n" }, { "example": 10, "flag": "-n", "param": "maxRecent", "type": "string", "text": "The maximum number of \\Recent messages in the mailboxes.
\n" }, { "example": "username", "flag": "user", "param": "user", "type": "string", "text": "The user to add.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "The mailbox to index.
\n" } ], "man": "doveadm-indexer", "text": "Add indexing request for the given user and the mailbox to the indexer queue.
\n", "man_link": "doveadm-indexer(1)",
"usage": "indexer add [-h] [-n max-recent] User Mask.
\n" } ], "man": "doveadm-indexer", "text": "List queued index requests.
\n", "man_link": "doveadm-indexer(1)",
"usage": "indexer list [user mask]",
"http_cmd": "indexerList"
},
"indexer remove": {
"args": [
{
"example": "username",
"flag": "user-mask",
"param": "userMask",
"type": "string",
"text": "User Mask.
\n" }, { "example": "Trash", "flag": "mailbox-mask", "param": "mailboxMask", "type": "string", "text": "The mailbox mask to remove.
\n" } ], "man": "doveadm-indexer", "text": "Remove index requests.
\n", "man_link": "doveadm-indexer(1)",
"usage": "indexer remove List Dovecot instances.
\n", "man_link": "doveadm-instance(1)",
"usage": "instance list [-c] [name]",
"http_cmd": "instanceList"
},
"instance remove": {
"args": [
{
"example": "instance_name",
"flag": "name",
"param": "name",
"type": "string",
"text": "The instance to remove.
\n" } ], "man": "doveadm-instance", "text": "Remove Dovecot instances.
\n", "man_link": "doveadm-instance(1)",
"usage": "instance remove Anvil socket path.
\n" }, { "example": "alt_username_field", "flag": "-f", "param": "passdbField", "type": "string", "text": "Alternative username field to use for kicking.
\n" }, { "example": "destination_host", "flag": "-h", "param": "destHost", "type": "string", "text": "Disconnect proxy connections to this destination host.
\n" }, { "example": "username", "flag": "mask", "param": "mask", "type": "array", "text": "UID mask.
\n" } ], "man": "doveadm-kick", "text": "Kick user.
\n", "man_link": "doveadm-kick(1)",
"usage": "kick [-a socket-path] [-f passdb-field] [-h dest-host] Only show errors since this point in time (UNIX timestamp).
\n" } ], "man": "doveadm-log", "text": "Fetch error logs.
\n", "man_link": "doveadm-log(1)",
"usage": "log errors [-c since]",
"http_cmd": "logErrors"
},
"log find": {
"args": [
{
"example": "/syslogd/write/path",
"flag": "log-dir",
"param": "logDir",
"type": "string",
"text": "Specify directory where syslogd writes files.
\n" } ], "man": "doveadm-log", "text": "Show the location of logs.
\n", "man_link": "doveadm-log(1)",
"usage": "log find [log dir]",
"http_cmd": "logFind"
},
"log reopen": {
"man": "doveadm-log",
"text": "Cause master process to reopen all log files.
\n", "man_link": "doveadm-log(1)",
"usage": "log reopen ",
"http_cmd": "logReopen"
},
"log test": {
"man": "doveadm-log",
"text": "Write a test message to the log files.
\n", "man_link": "doveadm-log(1)",
"usage": "log test ",
"http_cmd": "logTest"
},
"mail fs copy": {
"args": [
{
"flag": "filter-name",
"param": "filterName",
"type": "string",
"text": "Configuration filter name to use.
\n" }, { "flag": "--source-path", "param": "sourcePath", "type": "string", "text": "Source object path.
\n" }, { "flag": "--destination-path", "param": "destinationPath", "type": "string", "text": "Destination object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "Copy object in storage.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs copy Do recursive delete of path.
\n" }, { "flag": "-n", "param": "maxParallel", "type": "integer", "text": "Max number of parallel workers.
\n" }, { "flag": "filter-name", "param": "filterName", "type": "string", "text": "Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "Delete object from storage.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs delete [-R] [-n max-parallel] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "Get object from storage.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs get Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "List objects in fs path.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs iter [-C] [-O] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "List folders in fs path.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs iter-dirs Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs metadata Configuration filter name to use.
\n" }, { "flag": "input-path", "param": "inputPath", "type": "string", "text": "Object input path.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "Store object in storage.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs put [-h hash] [-m metadata] Configuration filter name to use.
\n" }, { "flag": "path", "param": "path", "type": "string", "text": "Object path.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mail-fs", "text": "Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.
\n", "man_link": "doveadm-mail-fs(1)",
"usage": "mail fs stat List or change all fields.
\n" }, { "example": "field1 field2", "flag": "-f", "param": "fieldstr", "type": "string", "text": "List or change these fields (comma/space separated).
\n" }, { "example": 2147483647, "flag": "-l", "param": "lastUsed", "type": "integer", "text": "Set last used timestamp.
\n" }, { "example": "yes", "flag": "-d", "param": "decision", "type": "string", "text": "Set field caching decision
\n" }, { "example": [ "Trash" ], "flag": "mailbox", "param": "mailbox", "type": "array", "text": "Mailboxes to change cache decisions for.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "List or change caching decisions for field(s).
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox cache decision [-a] [-f fieldstr] [-l last-used] [-d decision] Mailboxes to purge index file.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Purge the dovecot.index.cache file.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox cache purge Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Remove matching mails from the cache.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox cache remove Add to subscription list.
\n" }, { "example": "mailbox-guid", "flag": "-g", "param": "guid", "type": "string", "text": "Create mailbox with this GUID.
\n" }, { "example": [ "Test" ], "flag": "mailbox", "param": "mailbox", "type": "array", "text": "Mailboxes to create.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Create mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox create [-s] [-g guid] Operate on user keypair only.
\n" }, { "flag": "-R", "param": "reEncryptBoxKeys", "type": "boolean", "text": "Re-encrypt all folder keys with current active user key
\n" }, { "flag": "-f", "param": "force", "type": "boolean", "text": "Force keypair creation, normally keypair is only created if none found.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Mailbox mask.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "plugin": "mail-crypt", "man": "doveadm-mailbox-cryptokey", "text": "Generate new keypair for user or folder.
\nTo generate new active user key and re-encrypt all your keys with it can be\ndone with
\ndoveadm mailbox cryptokey generate -u username -URThis can be used to generate new user keypair and re-encrypt and create folder\nkeys.
\nINFO
\nYou must provide a password if you want to generate password-protected\nkeypair right away. You can also use doveadm mailbox cryptokey password\nto secure it.
doveadm-mailbox-cryptokey(1)",
"usage": "mailbox cryptokey generate [-U] [-R] [-f] Operate on user keypair only.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Mailbox mask.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "plugin": "mail-crypt", "man": "doveadm-mailbox-cryptokey", "text": "List all keys for user or mailbox.
\n", "man_link": "doveadm-mailbox-cryptokey(1)",
"usage": "mailbox cryptokey list [-U] Operate on user keypair only.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Mailbox mask.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "plugin": "mail-crypt", "man": "doveadm-mailbox-cryptokey", "text": "Exports user or folder private keys.
\n", "man_link": "doveadm-mailbox-cryptokey(1)",
"usage": "mailbox cryptokey export [-U] Clear password.
\n" }, { "flag": "-N", "param": "askNewPassword", "type": "boolean", "text": "Ask new password.
\n" }, { "example": "newpassword", "flag": "-n", "param": "newPassword", "type": "string", "text": "New password.
\n" }, { "flag": "-O", "param": "askOldPassword", "type": "boolean", "text": "Ask old password.
\n" }, { "example": "oldpassword", "flag": "-o", "param": "oldPassword", "type": "string", "text": "Old password.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" } ], "flags": 1, "plugin": "mail-crypt", "man": "doveadm-mailbox-cryptokey", "text": "Sets, changes or clears password for user's private key.
\n", "man_link": "doveadm-mailbox-cryptokey(1)",
"usage": "mailbox cryptokey password [-C] [-N] [-n new-password] [-O] [-o old-password] [-A] [-S socket-path] [-u user]",
"http_cmd": "mailboxCryptokeyPassword"
},
"mailbox delete": {
"args": [
{
"flag": "-e",
"param": "requireEmpty",
"type": "boolean",
"text": "Require mailboxes to be empty before deleting.
\n" }, { "flag": "-s", "param": "subscriptions", "type": "boolean", "text": "Unsubscribe deleted mailboxes.
\n" }, { "flag": "-r", "param": "recursive", "type": "boolean", "text": "Delete mailboxes recursively.
\n" }, { "flag": "-Z", "param": "unsafe", "type": "boolean", "text": "Delete mailboxes as efficiently as possible.
\n" }, { "example": [ "Test" ], "flag": "mailbox", "param": "mailbox", "type": "array", "text": "The mailboxes to delete.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Delete mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox delete [-e] [-s] [-r] [-Z] Allow to specify an empty mailbox name string.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Target mailbox to query.
\n" }, { "example": "key", "flag": "key", "param": "key", "type": "string", "text": "Metadata key to retrieve.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Get metadata for a mailbox.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox metadata get [-s] Allow to specify an empty mailbox name string.
\n" }, { "flag": "-p", "param": "prependPrefix", "type": "boolean", "text": "Prepend the prefix to results.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Target mailbox to query.
\n" }, { "example": "key-prefix", "flag": "key-prefix", "param": "keyPrefix", "type": "string", "text": "The key prefix to look for.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "List metadata for a mailbox.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox metadata list [-s] [-p] Allow to specify an empty mailbox name string.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Target mailbox.
\n" }, { "example": "key", "flag": "key", "param": "key", "type": "string", "text": "The key to add.
\n" }, { "example": "value", "flag": "value", "param": "value", "type": "string", "text": "The value to add.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Set metadata for a mailbox.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox metadata set [-s] Allow to specify an empty mailbox name string.
\n" }, { "example": "INBOX", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Target mailbox.
\n" }, { "example": "key", "flag": "key", "param": "key", "type": "string", "text": "The key to delete.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Unset metadata for a mailbox.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox metadata unset [-s] Lists mailboxes with mUTF-7 encoding.
\n" }, { "flag": "-8", "param": "utf8", "type": "boolean", "text": "Lists mailboxes with UTF-8 encoding.
\n" }, { "flag": "-s", "param": "subscriptions", "type": "boolean", "text": "Only list subscribed mailboxes.
\n" }, { "example": [ "INBOX" ], "flag": "mailbox-mask", "param": "mailboxMask", "type": "array", "text": "A list of mailbox masks to list.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Get list of existing mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox list [-7] [-8] [-s] [mailbox mask] [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "mailboxList"
},
"mailbox mutf7": {
"args": [
{
"flag": "-7",
"param": "toUtf8",
"type": "boolean",
"text": "Mailbox is in mUTF-7 format.
\n" }, { "flag": "-8", "param": "fromUtf8", "type": "boolean", "text": "Mailbox is in UTF-8 format.
\n" }, { "example": [ "Test" ], "flag": "name", "param": "name", "type": "array", "text": "Mailbox names to convert.
\n" } ], "man": "doveadm-mailbox", "text": "Convert mailbox names from mUTF-7 to UTF-8.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox mutf7 [-7] [-8] Mailbox path type.
\n" }, { "example": [ "INBOX" ], "flag": "mailbox", "param": "mailbox", "type": "array", "text": "Mailbox name to query.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Returns filesystem paths for the mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox path [-t type] Unsubscribe old mailbox and subscribe new mailbox.
\n" }, { "example": "OldName", "flag": "mailbox", "param": "mailbox", "type": "string", "text": "The source mailbox name.
\n" }, { "example": "NewName", "flag": "new-name", "param": "newName", "type": "string", "text": "The destination mailbox name.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Rename mailbox.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox rename [-s] Sum values of status fields.
\n" }, { "example": [ "all" ], "flag": "-f", "param": "field", "type": "array", "text": "Fields that should be shown.
\n" }, { "example": [ "INBOX" ], "flag": "mailbox-mask", "param": "mailboxMask", "type": "array", "text": "Mailboxes to query.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Show status of mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox status [-t] Mailboxes to subscribe to.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Subscribe to mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox subscribe Mailboxes to unsubscribe from.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Unsubscribe from mailboxes.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "mailbox unsubscribe Mailbox GUID.
\n" }, { "flag": "-V", "param": "uidValidity", "type": "integer", "text": "UID validity.
\n" }, { "flag": "-N", "param": "minNextUid", "type": "integer", "text": "Minimum NEXTUID.
\n" }, { "flag": "-R", "param": "minFirstRecentUid", "type": "integer", "text": "First recent UID.
\n" }, { "flag": "-H", "param": "minHighestModseq", "type": "integer", "text": "Minimum highest MODSEQ.
\n" }, { "flag": "-P", "param": "minHighestPrivateModseq", "type": "integer", "text": "Minimum highest private MODSEQ.
\n" }, { "flag": "mailbox", "param": "mailbox", "type": "string", "text": "Mailbox to update.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-mailbox", "text": "Set internal mailbox metadata.
\n", "man_link": "doveadm-mailbox(1)",
"usage": "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] The destination mailbox.
\n" }, { "example": "sourceuser", "flag": "source-user", "param": "sourceUser", "type": "string", "text": "Apply the search query to this user's mail_location.
For CLI use, this is specified by adding the keyword user followed by\nthe source user name, e.g., user sourceuser.
Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-move", "man_link": "doveadm-move(1)",
"usage": "move Anvil socket path.
\n" }, { "example": "127.0.0.0/8", "flag": "netmask", "param": "netmask", "type": "string", "text": "Filter output by netmask.
\n" } ], "man": "doveadm-penalty", "man_link": "doveadm-penalty(1)",
"usage": "penalty [-a socket-path] Filter output to only these services.
\n" } ], "man": "doveadm-process-status", "man_link": "doveadm-process-status(1)",
"usage": "process status [service]",
"http_cmd": "processStatus"
},
"proxy kick": {
"args": [
{
"cli_only": true,
"example": "/rundir/anvil",
"flag": "-a",
"param": "socketPath",
"type": "string",
"text": "Anvil socket path.
\n" }, { "example": "alt_username_field", "flag": "-f", "param": "passdbField", "type": "string", "text": "Alternative username field to use for kicking.
\n" }, { "example": "destination_host", "flag": "-h", "param": "destHost", "type": "string", "text": "Disconnect proxy connections to this destination host.
\n" }, { "example": "username", "flag": "mask", "param": "mask", "type": "array", "text": "UID mask.
\n" } ], "changed": [ { "text": "host argument has been changed to dest-host.user argument has been changed to mask.Kick user.
\n", "man_link": "doveadm-proxy(1)",
"usage": "proxy kick [-a socket-path] [-f passdb-field] [-h dest-host] Anvil socket path.
\n" }, { "flag": "-1", "param": "separateConnections", "type": "boolean", "text": "Output one entry per user/connection.
\n" }, { "example": "alt_username_field", "flag": "-f", "param": "passdbField", "type": "string", "text": "Alternative username field to use for listing.
\n" }, { "example": "username", "flag": "mask", "param": "mask", "type": "array", "text": "UID mask.
\n" } ], "added": [ { "text": "separate-connections, passdb-field, and mask arguments added.
The response format has changed.
\nDovecot now returns different formats based on the value of\nseparate-connections. If separate-connections is true, pid,\nip, dest_ip, and list of alt_username_fields (from anvil) is\nreturned.
Show who is logged into the Dovecot server.
\n", "man_link": "doveadm-proxy(1)",
"usage": "proxy list [-a socket-path] [-1] [-f passdb-field] Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-purge", "text": "Remove all messages with refcount=0 from a user's mail storage.
\n", "man_link": "doveadm-purge(1)",
"usage": "purge [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "purge"
},
"pw": {
"cli_only_cmd": true,
"args": [
{
"flag": "-l",
"param": "list",
"type": "boolean",
"text": "List all supported password schemes.
\n" }, { "example": "password", "flag": "-p", "param": "plaintext", "type": "string", "text": "Plaintext password.
\n" }, { "example": 5000, "flag": "-r", "param": "rounds", "type": "integer", "text": "Number of encryption rounds.
\n" }, { "example": "CRYPT", "flag": "-s", "param": "scheme", "type": "string", "text": "The password scheme to use.
\n" }, { "example": "password_hash", "flag": "-t", "param": "testHash", "type": "string", "text": "Test if hash matches password (e.g., plaintext argument).
Username to use for schemes that require one.
\n" }, { "flag": "-V", "param": "reverseVerify", "type": "boolean", "text": "Internally verify hashed password.
\n" } ], "man": "doveadm-pw", "text": "Generate password hashes.
\n", "man_link": "doveadm-pw(1)",
"usage": "pw [-l] [-p plaintext] [-r rounds] [-s scheme] [-t test-hash] [-u user] [-V]",
"http_cmd": "pw"
},
"quota get": {
"args": [
{
"example": false,
"flag": "-A",
"param": "allUsers",
"type": "boolean",
"text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "quota", "man": "doveadm-quota", "text": "Display current quota usage.
\n", "man_link": "doveadm-quota(1)",
"usage": "quota get [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "quotaGet"
},
"quota recalc": {
"args": [
{
"example": false,
"flag": "-A",
"param": "allUsers",
"type": "boolean",
"text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "quota", "man": "doveadm-quota", "text": "Recalculate current quota usage.
\n", "man_link": "doveadm-quota(1)",
"usage": "quota recalc [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "quotaRecalc"
},
"rebuild attachments": {
"args": [
{
"example": [
"mailbox",
"INBOX/myfoldertoo",
"savedbefore",
"since",
"30d"
],
"flag": "query",
"param": "query",
"type": "search_query",
"text": "Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-rebuild", "text": "Rebuild attachment detection information in index.
\n", "man_link": "doveadm-rebuild(1)",
"usage": "rebuild attachments Reload Dovecot configuration.
\n", "man_link": "doveadm(1)",
"usage": "reload ",
"http_cmd": "reload"
},
"save": {
"args": [
{
"example": "Test",
"flag": "-m",
"param": "mailbox",
"type": "string",
"text": "Save in this mailbox instead of INBOX.
\n" }, { "example": 1000, "flag": "-U", "param": "uid", "type": "integer", "text": "Save using this UID.
\n" }, { "example": 1000, "flag": "-g", "param": "guid", "type": "string", "text": "Save using this GID.
\n" }, { "example": "2007-04-13", "flag": "-r", "param": "receivedDate", "type": "string", "text": "Save with this as the received date.
\n" }, { "flag": "file", "param": "file", "type": "string", "text": "The message data to save.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "added": [ { "text": "received-date, uid, and gid arguments added.
Save messages to a mailbox.
\n", "man_link": "doveadm-save(1)",
"usage": "save [-m mailbox] [-U uid] [-g guid] [-r received-date] Search query to apply.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-search", "text": "Find matching messages in mailbox.
\n", "man_link": "doveadm-search(1)",
"usage": "search Filter output to only these services.
\n" } ], "man": "doveadm-service-status", "text": "Show information about Dovecot services.
\n", "man_link": "doveadm-service-status(1)",
"usage": "service status [service]",
"http_cmd": "serviceStatus"
},
"service stop": {
"args": [
{
"example": [
"stats"
],
"flag": "service",
"param": "service",
"type": "array",
"text": "The list of services to stop.
\n" } ], "man": "doveadm-service-stop", "text": "Stop Dovecot services.
\n", "man_link": "doveadm-service-stop(1)",
"usage": "service stop The script name to mark as active.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Mark active Sieve script.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve activate Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Deactivate Sieve script.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve deactivate [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "sieveDeactivate"
},
"sieve delete": {
"args": [
{
"flag": "-a",
"param": "ignoreActive",
"type": "boolean",
"text": "If set, allows the active script to be deleted.
\n" }, { "example": [ "scriptname" ], "flag": "scriptname", "param": "scriptname", "type": "array", "text": "The list of scripts to delete.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Delete Sieve scripts.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve delete [-a] The script to retrieve.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Retrieve a Sieve script.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve get Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "List Sieve scripts.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve list [-A] [-S socket-path] [-u user] [-F user-file]",
"http_cmd": "sieveList"
},
"sieve put": {
"args": [
{
"flag": "-a",
"param": "activate",
"type": "boolean",
"text": "Mark script as active.
\n" }, { "example": "scriptname", "flag": "scriptname", "param": "scriptname", "type": "string", "text": "The script to retrieve.
\n" }, { "flag": "file", "param": "file", "type": "istream", "text": "The script to add.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Add Sieve script to storage.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve put [-a] The old scriptname.
\n" }, { "example": "new_scriptname", "flag": "newname", "param": "newname", "type": "string", "text": "The new scriptname.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "plugin": "sieve", "man": "doveadm-sieve", "text": "Rename Sieve script.
\n", "man_link": "doveadm-sieve(1)",
"usage": "sieve rename Metric name.
\n" }, { "flag": "filter", "param": "filter", "type": "string" } ], "man": "doveadm-stats", "text": "Add metrics to statistics.
\n", "man_link": "doveadm-stats(1)",
"usage": "stats add [--exporter exporter] [--exporter-include exporter-include] [--description description] [--fields fields] [--group-by group-by] Path to socket path.
\n" }, { "flag": "-r", "param": "reset", "type": "boolean", "text": "Reset stats after dumping.
\n" }, { "flag": "-f", "param": "fields", "type": "string", "text": "Stats fields to return.
\n" } ], "man": "doveadm-stats", "text": "Output statistics.
\n", "man_link": "doveadm-stats(1)",
"usage": "stats dump [-s socketPath] [-r] [-f fields]",
"http_cmd": "statsDump"
},
"stats remove": {
"args": [
{
"example": "metric_name",
"flag": "name",
"param": "name",
"type": "string",
"text": "The metric to remove.
\n" } ], "man": "doveadm-stats", "text": "Remove metrics from statistics.
\n", "man_link": "doveadm-stats(1)",
"usage": "stats remove Reopen file exporter files.
\n", "man_link": "doveadm-stats(1)",
"usage": "stats reopen ",
"http_cmd": "statsReopen"
},
"stop": {
"man": "doveadm",
"text": "Stop Dovecot.
\n", "man_link": "doveadm(1)",
"usage": "stop ",
"http_cmd": "stop"
},
"sync": {
"args": [
{
"flag": "-f",
"param": "fullSync",
"type": "boolean",
"text": "Do full synchronization.
\n" }, { "flag": "-P", "param": "purgeRemote", "type": "boolean", "text": "Run a purge for remote after sync.
\n" }, { "flag": "-R", "param": "reverseSync", "type": "boolean", "text": "Do a reverse sync.
\n" }, { "example": 60, "flag": "-l", "param": "lockTimeout", "type": "integer", "text": "Lock timeout (in seconds).
\n" }, { "example": "/tmp/rawlog", "flag": "-r", "param": "rawlog", "type": "string", "text": "Rawlog path.
\n" }, { "example": "INBOX", "flag": "-m", "param": "mailbox", "type": "string", "text": "Only sync this mailbox.
\n" }, { "example": "mailbox-guid", "flag": "-g", "param": "mailboxGuid", "type": "string", "text": "Only sync this mailbox (by GUID).
\n" }, { "example": [ "#shared" ], "flag": "-n", "param": "namespace", "type": "array", "text": "Only sync this list of namespaces.
\n" }, { "flag": "-N", "param": "allNamespaces", "type": "boolean", "text": "Sync all namespaces.
\n" }, { "example": [ "Spam" ], "flag": "-x", "param": "excludeMailbox", "type": "array", "text": "Exclude these mailboxes.
\n" }, { "example": "AllMailbox", "flag": "-a", "param": "allMailbox", "type": "string", "text": "Name for the "All Mails" virtual mailbox.
\n" }, { "example": "state_string", "flag": "-s", "param": "state", "type": "string", "text": "Use stateful sync.
\n" }, { "example": "2023-04-13", "flag": "-t", "param": "syncSinceTime", "type": "string", "text": "Skip mails older than this date.
\n" }, { "example": "2023-10-21", "flag": "-e", "param": "syncUntilTime", "type": "string", "text": "Skip mails newer than this date.
\n" }, { "example": "\\Flagged", "flag": "-O", "param": "syncFlags", "type": "string", "text": "Sync only mails with this flag.
\n" }, { "example": "10M", "flag": "-I", "param": "syncMaxSize", "type": "string", "text": "Skip mails larger than this size.
\n" }, { "example": 600, "flag": "-T", "param": "timeout", "type": "integer", "text": "Timeout for stalled I/O operations.
\n" }, { "flag": "-d", "param": "defaultDestination", "type": "boolean", "text": "Use the default destination.
\n" }, { "flag": "-1", "param": "onewaySync", "type": "boolean", "text": "Do one-way synchronization.
\n" }, { "example": [ "maildir:~/Maildir" ], "flag": "destination", "param": "destination", "type": "array", "text": "Sync destinations.
\n" }, { "example": false, "flag": "-A", "param": "allUsers", "type": "boolean", "text": "Apply operation to all users.
\n" }, { "example": "/var/run/dovecot/doveadm-server", "flag": "-S", "param": "socketPath", "type": "string", "text": "Path to doveadm socket.
\n" }, { "example": "username", "flag": "-u", "param": "user", "type": "string", "text": "UID of user to apply operation to.
\n" }, { "flag": "-F", "param": "userFile", "type": "string", "text": "A filename. If set, fetch usernames from file. One username per line.
\n" } ], "flags": 3, "man": "doveadm-sync", "text": "Dovecot's mailbox synchronization utility.
\nThis command cannot be used safely via API by untrusted users.
\n", "man_link": "doveadm-sync(1)",
"usage": "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] [-1] userdb socket path
\n" }, { "example": [ "service=imap" ], "flag": "-x", "param": "authInfo", "type": "array", "text": "Additional conditions for auth lookup.
\n" }, { "example": "userdb_field", "flag": "-f", "param": "field", "type": "string", "text": "Only show value of this field.
\n" }, { "flag": "-e", "param": "expandField", "type": "string" }, { "flag": "-u", "param": "userdbOnly", "type": "boolean", "text": "Only show values from userdb.
\n" }, { "example": "username", "flag": "user-mask", "param": "userMask", "type": "string", "text": "User Mask.
\n" } ], "man": "doveadm-user", "text": "Lookup user in Dovecot's userdbs.
\n", "man_link": "doveadm-user(1)",
"usage": "user [-a socket-path] [-x auth-info] [-f field] [-e expand-field] [-u] Anvil socket path.
\n" }, { "flag": "-1", "param": "separateConnections", "type": "boolean", "text": "Output one entry per user/connection.
\n" }, { "example": "alt_username_field", "flag": "-f", "param": "passdbField", "type": "string", "text": "Alternative username field to use for lookup.
\n" }, { "example": "username", "flag": "mask", "param": "mask", "type": "array", "text": "UID -or- IP Address mask.
\n" } ], "response": { "example": [ { "username": "foo", "connections": "1", "service": "imap", "pid": "(47)", "ip": "(10.0.2.100)" } ], "text": "Returns an array of objects.
\nIf separate-connections is false, each object represents a single\nusername/service combination, and the pid and ip fields will include\nall entries for that combination.
If separate-connections is true, each object will contain a single\nconnection.
Object fields:
\n| Key | \nDescription | \n
|---|---|
connections | \nThe total number of connections for the user. This is only returned if separate-connections is false. | \n
ip | \nIP addresses where the user's connections are originating. | \n
pid | \nProcess IDs of the session. | \n
service | \nThe Dovecot service. | \n
username | \nUsername | \n
Show who is logged into the Dovecot server.
\n", "man_link": "doveadm-who(1)",
"usage": "who [-a socket-path] [-1] [-f passdb-field]