.TH "DOVEADM-DICT" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-dict\fR - Commands related to dictionary manipulation in user context
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBdict\fR \fIcommand\fR \[lB]\fB-u\fR \fIuser\fR\[rB] \[lB]\fIOPTIONS\fR\[rB] \fIconfig-filter-name\fR \[lB]\fIargs\fR\[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBmail dict\fR \fIcommand\fR \[lB]\fIOPTIONS\fR\[rB] \fIconfig-filter-name\fR \[lB]\fIargs\fR\[rB]
.SH "DESCRIPTION"
.P
\fBdoveadm dict\fR and \fBdoveadm mail dict\fR can be used to query and modify dictionary entries.
.P
The \fBdoveadm mail dict\fR command can be used within a specific user context. This may be useful if e.g. userdb lookup returns user-specific dict settings. Otherwise the commands behave identically.
.P
\fIconfig-filter-name\fR
.RS 0
.RS 4
.P
Filter name to use when looking up the dict settings. For example \fImail_attribute\fR, \fIquota_clone\fR. It's also possible to use an empty filter name and specify the dict settings using the \fB-o\fR parameters.
.RE 0

.RE 0

.SH "GLOBAL OPTIONS"
.P
Global doveadm(1) 
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0

.RE 0

.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with 
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0

.RE 0

.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0

.RE 0

.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.P
\fB-f\fR \fIformatter\fR
.RS 0
.RS 4
.P
Specifies the \fIformatter\fR for formatting the output. Supported formatters are:
.P
\fBflow\fR
.RS 4
.P
prints each line with \fIkey\fR\fB=\fR\fIvalue\fR pairs.
.RE 0

.P
\fBpager\fR
.RS 4
.P
prints each \fIkey\fR: \fIvalue\fR pair on its own line and separates records with form feed character (\fB^L\fR).
.RE 0

.P
\fBtab\fR
.RS 4
.P
prints a table header followed by tab separated value lines.
.RE 0

.P
\fBtable\fR
.RS 4
.P
prints a table header followed by adjusted value lines.
.RE 0

.RE 0

.RE 0

.SH "OPTIONS"
.P
\fBdoveadm dict\fR command-specific \fIoptions\fR:
.P
\fB-u\fR \fIuser\fR
.RS 0
.RS 4
.P
The user to use.
.RE 0

.RE 0

.P
\fBdoveadm mail dict\fR command-specific \fIoptions\fR:
.P
\fB-A\fR
.RS 0
.RS 4
.P
If the \fB-A\fR option is present, the \fIcommand\fR will be performed for all users. Using this option in combination with system users from \fBuserdb { driver = passwd }\fR is not recommended, because it contains also users with a lower UID than the one configured with the \fBfirst_valid_uid\fR setting.
.P
When the SQL userdb module is used, make sure that the \fBuserdb_sql_iterate_query\fR setting setting matches your database layout.
.P
When using the LDAP userdb module, make sure that the \fBuserdb_fields\fR setting and \fBuserdb_ldap_iterate_fields\fR setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
.RE 0

.RE 0

.P
\fB-F\fR \fIfile\fR
.RS 0
.RS 4
.P
Execute the \fIcommand\fR for all the users in the \fIfile\fR. This is similar to the \fB-A\fR option, but instead of getting the list of users from the userdb, they are read from the given \fIfile\fR. The \fIfile\fR contains one username per line.
.RE 0

.RE 0

.P
\fB-S\fR \fIsocket_path\fR
.RS 0
.RS 4
.P
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (\fIhostname\fR:\fIport\fR), in order to connect a remote host via a TCP socket.
.P
This allows an administrator to execute doveadm(1) mail commands through the given socket.
.RE 0

.RE 0

.P
\fB-u\fR \fIuser/mask\fR
.RS 0
.RS 4
.P
Run the \fIcommand\fR only for the given \fIuser\fR. It's also possible to use '\fB*\fR' and '\fB?\fR' wildcards (e.g. -u *@example.org).
.RE 0

.RE 0

.SH "COMMANDS"
.SS "get"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] dict get \[lB]\fB-u\fR \fIuser\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail dict get \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR
.P
Fetch a key from a dictionary.
.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to fetch.
.RE 0

.RE 0

.SS "iter"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] dict iter \[lB]\fB-u\fR \fIuser\fR\[rB] \[lB]\fB-1RV\fR\[rB] \fIconfig-filter-name\fR \fIprefix\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail dict iter \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-1RV\fR\[rB] \fIconfig-filter-name\fR \fIprefix\fR
.P
Find the keys matching the a prefix in a dictionary.
.P
\fB-1\fR
.RS 0
.RS 4
.P
Exact match.
.RE 0

.RE 0

.P
\fB-R\fR
.RS 0
.RS 4
.P
Recurse.
.RE 0

.RE 0

.P
\fB-V\fR
.RS 0
.RS 4
.P
Don't print values, just key names
.RE 0

.RE 0

.P
\fIprefix\fR
.RS 0
.RS 4
.P
The key prefix to look for.
.RE 0

.RE 0

.P
List keys into the dictionary.
.SS "inc"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] dict inc \[lB]\fB-u\fR \fIuser\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR \fIdiff\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail dict inc \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR \fIdiff\fR
.P
Increment the value of a numeric key in the keys into the dictionary.
.P
\fB-t\fR \fItimestamp-msecs\fR
.RS 0
.RS 4
.P
Set the timestamp also.
.RE 0

.RE 0

.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to increment.
.RE 0

.RE 0

.P
\fIdiff\fR
.RS 0
.RS 4
.P
The amount of the increment.
.RE 0

.RE 0

.SS "set"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] dict set \[lB]\fB-u\fR \fIuser\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \[lB]\fB-e\fR \fIexpire-secs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR \fIvalue\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail dict set \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \[lB]\fB-e\fR \fIexpire-secs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR \fIvalue\fR
.P
Set/create keys into the dictionary.
.P
\fB-t\fR \fItimestamp-msecs\fR
.RS 0
.RS 4
.P
Set the timestamp also.
.RE 0

.RE 0

.P
\fB-e\fR \fIexpire-secs\fR
.RS 0
.RS 4
.P
Set the key duration also.
.RE 0

.RE 0

.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to set.
.RE 0

.RE 0

.P
\fIvalue\fR
.RS 0
.RS 4
.P
The value to set.
.RE 0

.RE 0

.SS "unset"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] dict unset \[lB]\fB-u\fR \fIuser\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail dict unset \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-t\fR \fItimestamp-msecs\fR\[rB] \fIconfig-filter-name\fR \fIkey\fR
.P
Remove a key from the dictionary.
.P
\fB-t\fR \fItimestamp-msecs\fR
.RS 0
.RS 4
.P
Set the timestamp also.
.RE 0

.RE 0

.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to unset.
.RE 0

.RE 0

.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)