DOVEADM-MOVE(1)

πŸ’Œ DOVEADM-MOVE β€” the Dovecot move girlies know πŸ’Œ

okay bestie, this is doveadm-move from the Dovecot manual (section 1, the user-commands one). Buckle up, we're moving mail around and it's giving main character energy ✨


✨ NAME ✨

doveadm-move β€” Move messages matching the given search query into another mailbox πŸ¦‹


🌸 SYNOPSIS 🌸

doveadm [GLOBAL OPTIONS] move [-S socket_path] -A destination [user
source_user] search_query

doveadm [GLOBAL OPTIONS] move [-S socket_path] -F file destination [user
source_user] search_query

doveadm [GLOBAL OPTIONS] move [-S socket_path] --no-userdb-lookup
destination [user source_user] search_query

doveadm [GLOBAL OPTIONS] move [-S socket_path] -u user destination [user
source_user] search_query

doveadm [GLOBAL OPTIONS] copy [-S socket_path] -A destination [user
source_user] search_query

doveadm [GLOBAL OPTIONS] copy [-S socket_path] -F file destination [user
source_user] search_query

doveadm [GLOBAL OPTIONS] copy [-S socket_path] --no-userdb-lookup
destination [user source_user] search_query

doveadm [GLOBAL OPTIONS] copy [-S socket_path] -u user destination [user
source_user] search_query

πŸ’… DESCRIPTION πŸ’…

doveadm move is literally here to move mails between mailboxes, for one user or a whole lil crowd of them. The search_query is the vibe check that decides which messages get yeeted into the destination mailbox. πŸŽ€

doveadm copy behaves exactly the same as doveadm move β€” except the copied messages will not be expunged after copying. So they stay. They're not going anywhere. Iconic behaviour, honestly.

In the first form, doveadm(1) will iterate over all users found in the configured user_db (s), and move or copy each user's messages that match the given search_query into that user's destination mailbox. πŸ’«

In the second form, doveadm(1) will iterate over all users found in the given file, and move or copy each user's messages matching the given search_query into the user's destination mailbox. πŸ“„

In the third form, matching mails will be moved or copied only for the given user(s). Just the one. Just her. 🫢


🌈 GLOBAL OPTIONS 🌈

These are the global doveadm(1) options, the ones that apply to everything, not just this command:

  • -D β€” Enables verbosity and debug messages. She's talkative. She's telling you everything. πŸ—£οΈ
  • -O β€” Do not read any config file, just use defaults. The dovecot_storage_version setting defaults to the latest version, but you can override it with -o.
  • -k β€” Preserve the entire environment for doveadm, not just the import_environment setting. Keep the whole vibe intact. ✨
  • -v β€” Enables verbosity, including a progress counter. Progress bar bestie, we love to see it. πŸ“ˆ
  • -i instance-name β€” If you're running multiple Dovecot instances, pick the config file based on this instance name. See the instance_name setting for more info.
  • -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 at the config socket of some instance running a compatible version. πŸ‘€
  • -o setting=value β€” Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. Want to override multiple settings? The -o option may be specified multiple times. Stack 'em. 🧚

πŸ‘‘ OPTIONS πŸ‘‘

  • -A β€” If the -A option is present, the command will be performed for all users. Using this option in combination with system users from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID than the one configured with the first_valid_uid setting.

When the SQL userdb module is used, make sure that the userdb_sql_iterate_query setting setting matches your database layout. fr fr, check it.

When using the LDAP userdb module, make sure that the userdb_fields setting and userdb_ldap_iterate_fields setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users. 😭

  • -F file β€” Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line. One name per line, no cap. πŸ“
  • --no-userdb-lookup β€” Do not perform userdb lookup. Use the USER environment variable to specify the username.
  • -S socket_path β€” The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname:port), in order to connect a remote host via a TCP socket.

This allows an administrator to execute doveadm(1) mail commands through the given socket. πŸ”Œ

  • -u user/mask β€” Run the command only for the given user. It's also possible to use '*' and '?' wildcards (e.g. -u *@example.org). Wildcards are so underrated honestly. 🌟

πŸŽ€ ARGUMENTS πŸŽ€

  • destination β€” The name of the destination mailbox, into which the mails should be moved or copied. The destination mailbox must exist, otherwise this command will fail. No mailbox, no move, sorry babe. πŸ’€
  • search_query β€” Move/copy messages matching the given search query. See doveadm-search-query(7) for details.

For the move command, the mailbox parameter is REQUIRED. Non-negotiable.

For the move command, a message range limiter is REQUIRED. In other words, you must have at least one query parameter that limits the message range. If all messages are needed, the "all" query parameter can be used. Yes, "all" counts. She's valid. 🫢

  • user source_user β€” The keyword user followed by a valid user name. When this argument is present, doveadm(1) will apply the search_query to the source_user's mail location.

Limitation: Currently the users, specified by -u user and user source_user, must share the same system UID and GID. Same UID, same GID, no exceptions bestie. 😭


πŸ¦‹ EXAMPLE πŸ¦‹

Move jane's messages β€” received in September 2011 β€” from her INBOX into her archive:

doveadm move -u jane Archive/2011/09 mailbox INBOX BEFORE \
  2011-10-01 SINCE 01-Sep-2011

Look at her go. Organized queen. πŸ‘‘


πŸ”₯ REPORTING BUGS πŸ”₯

Found a bug? Report bugs, including doveconf -n output, to the Dovecot Mailing List ⟨dovecot@dovecot.org⟩. Info about reporting bugs is available at: ⟨https://dovecot.org/bugreport.html⟩

(Please include the doveconf -n output, they will ask, save yourself the round trip πŸ’–)


🌈 SEE ALSO 🌈


and that's the whole page, bestie!! πŸ’–βœ¨ you understood all of it, i know you did, you're literally so smart 🫢

this lil gem is from Dovecot, source/version tag f979264, dated April 2026 β€” go forth and move some mail, mwah πŸ’…πŸŒΈ

πŸ“¦ where this page comes from