doveadm-dict¶

NAME¶

doveadm-dict - Commands related to dictionary manipulation

SYNOPSIS¶

doveadm [GLOBAL OPTIONS] dict command [-u user] dict-uri [args]

DESCRIPTION¶

doveadm dict can be used to query and modify dictionary entries.

GLOBAL OPTIONS¶

Global doveadm(1) options:

-D: Enables verbosity and debug messages.
-O: Do not read any config file, just use defaults.
-k: Preserve entire environment for doveadm, not just import_environment.
-v: Enables verbosity, including progress counter.
-i instance-name: If using multiple Dovecot instances, choose the config file based on this instance name. See instance_name setting for more information.
-c config-file: Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.
-o setting=value: Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

-f formatter

Specifies the formatter for formatting the output. Supported formatters are:

flow: prints each line with key=value pairs.
pager: prints each key: value pair on its own line and separates records with form feed character (^L).
tab: prints a table header followed by tab separated value lines.
table: prints a table header followed by adjusted value lines.

-u user: The user to use.
dict-uri: The uri to the dictionary being manipulated.

COMMANDS¶

doveadm dict get¶

doveadm [GLOBAL OPTIONS] dict get [-u user] dict-uri key

Fetch a key from a dictionary.

key: The key to fetch.

doveadm dict iter¶

doveadm [GLOBAL OPTIONS] dict iter [-u user] [-1RV] dict-uri prefix

Find the keys matching the a prefix in a dictionary.

-1: Exact match.
-R: Recurse.
-V: Don’t print values, just key names
prefix: The key prefix to look for.

List keys into the dictionary.

doveadm dict inc¶

doveadm [GLOBAL OPTIONS] dict inc [-u user] [-t timestamp-msecs] dict-uri key diff

Increment the value of a numeric key in the keys into the dictionary.

-t timestamp-msecs

key: The key to increment.
diff: The amount of the increment.

doveadm dict set¶

doveadm [GLOBAL OPTIONS] dict set [-u user] [-t timestamp-msecs] [-e expire-secs] dict-uri key value

Set/create keys into the dictionary.

-t timestamp-msecs: Set the timestamp also.
-e expire-secs: Set the key duration also.
key: The key to set.
value: The value to set.

doveadm dict unset¶

doveadm [GLOBAL OPTIONS] dict unset [-u user] [-t timestamp-msecs] dict-uri key

Remove a key from the dictionary.

-t timestamp-msecs: Set the timestamp also.
key: The key to unset.

REPORTING BUGS¶

Report bugs, including doveconf -n output, to the Dovecot Mailing List <dovecot@dovecot.org>. Information about reporting bugs is available at: https://dovecot.org/bugreport.html