1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
|
.TH "DOVEADM-MAILBOX" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-mailbox\fR - Commands related to handling mailboxes
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \[lB]\fB-f\fR \fIformatter\fR\[rB] \fImailbox_cmd\fR \[lB]\fIOPTIONS\fR\[rB] \[lB]\fIARGUMENTS\fR\[rB]
.SH "DESCRIPTION"
.P
\fBdoveadm mailbox\fR can be used to query and modify mailboxes.
.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
\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--no-userdb-lookup\fR
.RS 0
.RS 4
.P
Do not perform userdb lookup. Use the \fBUSER\fR environment variable to specify the username.
.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 "ARGUMENTS"
.P
\fImailbox\fR
.RS 0
.RS 4
.P
Is the name of a \fImailbox\fR, as visible to IMAP clients, except in UTF-8 format. The hierarchy separator between a parent and child mailbox is commonly '\fB/\fR' or '\fB.\fR', but this depends on your selected mailbox storage format and namespace configuration. The mailbox names may also require a namespace prefix.
.RE 0
.RE 0
.SH "COMMANDS"
.SS "mailbox create"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox create \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-g\fR \fIguid\fR\[rB] \[lB]\fB-s\fR\[rB] \fImailbox\fR...
.P
This command is used to create one or more mailboxes. The mailbox format of the created mailboxes depends on the \fImail_driver\fR setting, or the user's \fImail\fR field, returned by the userdb.
.P
\fB-g\fR \fIguid\fR
.RS 0
.RS 4
.P
Create the mailbox with the specified GUID.
.RE 0
.RE 0
.P
\fB-s\fR
.RS 0
.RS 4
.P
When this option was given, the created mailboxes will be also added to the user's subscriptions.
.RE 0
.RE 0
.SS "mailbox cryptokey"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox cryptokey \fBexport|generate|list|password\fR
.P
This command is used to manage mail crypt plugin cryptographic keys. Please see doveadm-mailbox-cryptokey(1) for more details.
.SS "mailbox delete"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox delete \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \[lB]\fB-r\fR\[rB] \[lB]\fB-e\fR\[rB] \[lB]\fB-Z\fR\[rB] \fImailbox\fR...
.P
This command deletes a mailbox and expunges all the messages it contains. If the mailbox has any children, they won't be deleted, unless \fB-r\fR is given.
.P
\fB-r\fR
.RS 0
.RS 4
.P
Delete mailboxes recursively
.RE 0
.RE 0
.P
\fB-s\fR
.RS 0
.RS 4
.P
Unsubscribe deleted mailboxes.
.RE 0
.RE 0
.P
\fB-e\fR
.RS 0
.RS 4
.P
Require mailboxes to be empty before deleting.
.RE 0
.RE 0
.P
\fB-Z\fR
.RS 0
.RS 4
.P
Delete the mailbox as efficiently as possible, but the user may not be in fully consistent state afterwards. For example quota may be wrong. This option is mainly useful when deleting the entire user.
.RE 0
.RE 0
.SS "mailbox list"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox list \[lB]\fB-7\fR | \fB-8\fR\[rB] \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \[lB]\fImailbox\fR ...\[rB]
.P
To get an overview of existing mailboxes use this command. It's also possible to use wildcards in the \fImailbox\fR name.
.P
When the \fB-s\fR option is present, only subscribed mailboxes will be listed. Listed subscriptions may also contain mailboxes that are already deleted.
.P
\fB-7\fR
.RS 0
.RS 4
.P
Lists the mailboxes with mUTF-7 encoding.
.RE 0
.RE 0
.P
\fB-8\fR
.RS 0
.RS 4
.P
Lists the mailboxes with UTF-8 encoding.
.RE 0
.RE 0
.SS "mailbox metadata list"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox metadata list \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \[lB]\fB-p\fR\[rB] \fImailbox\fR \[lB]\fIkey-prefix\fR\[rB]
.P
\fB-s\fR
.RS 0
.RS 4
.P
Allows to specify \fImailbox\fR "", which points to the server metadata instead of mailboxes' matadata. It has no effect if mailbox is anything else than an empty string.
.RE 0
.RE 0
.P
\fB-p\fR
.RS 0
.RS 4
.P
Prepend prefix.
.RE 0
.RE 0
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The target mailbox (mandatory). If \fB-s\fR is specified, the empty string "" can be used to indicate access to server metadata.
.RE 0
.RE 0
.P
\fIkey-prefix\fR
.RS 0
.RS 4
.P
The key prefix to look for. All keys will be listed if not provided.
.RE 0
.RE 0
.SS "mailbox metadata get"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox metadata get \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \fImailbox\fR \fIkey\fR
.P
\fB-s\fR
.RS 0
.RS 4
.P
Allows to specify \fImailbox\fR "", which points to the server metadata instead of mailboxes' matadata. It has no effect if mailbox is anything else than an empty string.
.RE 0
.RE 0
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The target mailbox (mandatory). If \fB-s\fR is specified, the empty string "" can be used to indicate access to server metadata.
.RE 0
.RE 0
.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to retrieve.
.RE 0
.RE 0
.SS "mailbox metadata set"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox metadata set \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \fImailbox\fR \fIkey\fR \fIvalue\fR
.P
\fB-s\fR
.RS 0
.RS 4
.P
Allows to specify \fImailbox\fR "", which points to the server metadata instead of mailboxes' matadata. It has no effect if mailbox is anything else than an empty string.
.RE 0
.RE 0
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The target mailbox (mandatory). If \fB-s\fR is specified, the empty string "" can be used to indicate access to server metadata.
.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 "mailbox metadata unset"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox metadata unset \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \fImailbox\fR \fIkey\fR
.P
\fB-s\fR
.RS 0
.RS 4
.P
Allows to specify \fImailbox\fR "", which points to the server metadata instead of mailboxes' matadata. It has no effect if mailbox is anything else than an empty string.
.RE 0
.RE 0
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The target mailbox (mandatory). If \fB-s\fR is specified, the empty string "" can be used to indicate access to server metadata.
.RE 0
.RE 0
.P
\fIkey\fR
.RS 0
.RS 4
.P
The key to unset.
.RE 0
.RE 0
.SS "mailbox mutf7"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox mutf7 \[lB]\fB-7\fR | \fB-8\fR\[rB] \fIname\fR...
.P
into a modified version of the UTF-7 encoding and vice versa. See RFC 3501 (Mailbox International Naming Convention).
.P
\fB-7\fR
.RS 0
.RS 4
.P
Indicates that the \fIname\fR's string representation is mUTF-7 encoded and it should be converted to UTF-8.
.RE 0
.RE 0
.P
\fB-8\fR
.RS 0
.RS 4
.P
Indicates that the \fIname\fR's is UTF-8 encoded and should be converted to mUTF-7 (default).
.RE 0
.RE 0
.P
\fIname\fR
.RS 0
.RS 4
.P
One or more mailbox names that should be converted.
.RE 0
.RE 0
.SS "mailbox path"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox path \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \[lB]\fB-t\fR \fItype\fR\[rB] \fImailbox\fR
.P
The \fBmailbox path\fR command returns the filesystem path for the given mailbox. By default, this is the path to the "index" directory.
.P
\fB-t\fR \fItype\fR
.RS 0
.RS 4
.P
Output the path to this mailbox location type. One of:
.RS 4
.IP \(bu 4
\fBalt-dir\fR
.IP \(bu 4
\fBalt-mailbox\fR
.IP \(bu 4
\fBcontrol\fR
.IP \(bu 4
\fBdir\fR
.IP \(bu 4
\fBindex\fR (DEFAULT)
.IP \(bu 4
\fBindex-cache\fR
.IP \(bu 4
\fBindex-private\fR
.IP \(bu 4
\fBlist-index\fR
.IP \(bu 4
\fBmailbox\fR
.RE 0
.RE 0
.RE 0
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The mailbox to query (mandatory).
.RE 0
.RE 0
.SS "mailbox rename"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox rename \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-s\fR\[rB] \fIold_name\fR \fInew_name\fR
.P
The \fBmailbox rename\fR command is used to rename the mailbox \fIold_name\fR to \fInew_name\fR.
.P
When the \fB-s\fR option is given, \fIold_name\fR will be unsubscribed and \fInew_name\fR will be subscribed.
.SS "mailbox status"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox status \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-t\fR\[rB] \fIfields\fR \fImailbox\fR...
.P
Show the \fBstatus\fR of one or more mailboxes. The \fImailbox\fR name may also contain wildcards.
.P
This command uses by default the output \fIformatter\fR \fBflow\fR.
.P
\fB-t\fR
.RS 0
.RS 4
.P
Summarize the values of the status \fIfields\fR \fBmessages\fR, \fBrecent\fR, \fBunseen\fR and/or \fBvsize\fR of multiple mailboxes to a sum (total).
.RE 0
.RE 0
.P
\fBfields\fR
.RS 0
.RS 4
.P
Specify the status \fIfields\fR which should be shown.
.P
In order to specify multiple status \fIfields\fR, enclosed them in quotes.
.RS 4
.P
\fBall\fR : This is a special status field name. It means show all of the following \fIfields\fR. When the \fB-t\fR option is present, it means show only the \fBmessages\fR, \fBrecent\fR, \fBunseen\fR and \fBvsize\fR \fIfields\fR.
.RE 0
.RS 4
.P
\fBguid\fR : The \fImailbox\fR's globally unique identifier.
.RE 0
.RS 4
.P
\fBhighestmodseq\fR : The highest mod-sequence value of all messages in the \fImailbox\fR.
.RE 0
.RS 4
.P
\fBmessages\fR : The number of messages in the \fImailbox\fR.
.RE 0
.RS 4
.P
\fBrecent\fR : The number of messages with the \[rs]Recent flag set.
.RE 0
.RS 4
.P
\fBuidnext\fR : The next unique identifier value.
.RE 0
.RS 4
.P
\fBuidvalidity\fR : The unique identifier validity value.
.RE 0
.RS 4
.P
\fBunseen\fR : The message sequence number of the first unseen message in the \fImailbox\fR.
.RE 0
.RS 4
.P
\fBvsize\fR : The \fImailbox\fR's virtual size, computed with CRLF line terminators.
.RE 0
.RS 4
.P
\fBfirstsaved\fR : Saved time of the first mail in the mailbox.
.RE 0
.RE 0
.RE 0
.SS "mailbox subscribe"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox subscribe \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fImailbox\fR \fI...\fR
.P
This command is used to subscribe one or more mailboxes.
.SS "mailbox unsubscribe"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox unsubscribe \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fImailbox\fR \fI...\fR
.P
This command is used to unsubscribe one or more mailboxes.
.SS "mailbox update"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox update \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB--mailbox-guid\fR \fIguid\fR\[rB] \[lB]\fB--uid-validity\fR \fIuid\fR\[rB] \[lB]\fB--min-next-uid\fR \fIuid\fR\[rB] \[lB]\fB--min-first-recent-uid\fR \fIuid\fR\[rB] \[lB]\fB--min-highest-modseq\fR \fIseq\fR\[rB] \[lB]\fB--min-highest-pvt-modseq\fR \fIseq\fR\[rB] \fImailbox\fR \fI...\fR
.P
This command is used to set UID validity, next UID, first recent UID and modification sequence values.
.P
Usually this is only ever to be used during migration, or restoring mailbox after disaster. Settings these values is highly discouraged, and is not supported for all mail backends.
.SS "mailbox cache purge"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox cache purge \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fImailbox\fR \fI...\fR
.P
Purge the dovecot.index.cache file. Most importantly this frees up disk space from mails that were already deleted. Normally there i no need to run this command manually, because the compression is also run automatically.
.SS "mailbox cache decision"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox cache decision \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB--all\fR\[rB] \[lB]\fB--fields\fR \fIlist of fields\fR\[rB] \[lB]\fB--last-used\fR \fIunix timestamp\fR\[rB] \[lB]\fB--decision\fR \fIno|temp|yes\fR\[rB] \fImailbox\fR \fI...\fR
.P
This command is used to list or change caching decisions for field(s) in mailbox(es). You can list decisions by leaving out decision and last-used parameters.
.P
\fB--all\fR
.RS 0
.RS 4
.P
List or change all fields.
.RE 0
.RE 0
.P
\fB--fields\fR
.RS 0
.RS 4
.P
List or change these comma/space separated fields.
.RE 0
.RE 0
.P
\fB--decision\fR
.RS 0
.RS 4
.P
Set field caching decision. Yes means it's always cached. Temp means it's provisionally cached. No means the field is not cached.
.RE 0
.RE 0
.P
\fB--last-used\fR
.RS 0
.RS 4
.P
Set field's last used timestamp.
.RE 0
.RE 0
.P
NOTE: This command cannot be used to add new fields to cache! You need to first add them to configuration. Setting caching to no will not immediately drop field from cache, it will stop adding the field to cache.
.SS "mailbox cache remove"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mailbox cache remove \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR | \fB--no-userdb-lookup\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIsearch query\fR
.P
Remove any matching mail(s) from cache.
.P
WARNING! This command can erase ALL cached data, causing system slowness.
.P
See doveadm-search-query(7) for the search query syntax.
.SH "EXAMPLE"
.P
List subscribed mailboxes, beginning with 'dovecot', of user bob:
.P
.RS 2
.nf
doveadm mailbox list -s -u bob dovecot\[rs]*
.fi
.RE
.P
.RS 2
.nf
dovecot
dovecot/pigeonhole
dovecot/pigeonhole/2.0
.fi
.RE
.P
Now have a look at the status of user bob's dovecot mailboxes:
.P
.RS 2
.nf
doveadm -f table mailbox status -u bob "messages vsize" dovecot\[rs]*
.fi
.RE
.P
.RS 2
.nf
mailbox messages vsize
dovecot 20501 93968492
dovecot/pigeonhole 0 0
dovecot/pigeonhole/2.0 47 323474
.fi
.RE
.P
Converting an internationalized mailbox name from mUTF-7 to UTF-8 and vice versa:
.P
.RS 2
.nf
doveadm mailbox mutf7 -7 "~peter/mail/&U,BTFw-/&ZeVnLIqe-"
.fi
.RE
.P
.RS 2
.nf
~peter/mail/台北/日本語
.fi
.RE
.P
.RS 2
.nf
doveadm mailbox mutf7 ~peter/mail/台北/日本語
.fi
.RE
.P
.RS 2
.nf
~peter/mail/&U,BTFw-/&ZeVnLIqe-
.fi
.RE
.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)
|