Skip to content

Commit

Permalink
man: Add doveadm mailbox path
Browse files Browse the repository at this point in the history
  • Loading branch information
slusarz committed Aug 29, 2024
1 parent ce407ca commit 4bfafbf
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
6 changes: 4 additions & 2 deletions data/doveadm.js
Original file line number Diff line number Diff line change
Expand Up @@ -1564,11 +1564,13 @@ to secure it.
args: {
type: {
cli: 't',
type: doveadm_arg_types.STRING
type: doveadm_arg_types.STRING,
text: `Mailbox path type.`
},
mailbox: {
positional: true,
type: doveadm_arg_types.ARRAY
type: doveadm_arg_types.ARRAY,
text: `Mailbox name to query.`
},
},
flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE,
Expand Down
23 changes: 23 additions & 0 deletions docs/core/man/doveadm-mailbox.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,29 @@ Convention).
*name*
: One or more mailbox names that should be converted.

### mailbox path

**doveadm** [*GLOBAL OPTIONS*] mailbox path [**-A** | **-u** *user* | **-F** *file* | **\-\-no-userdb-lookup**] [**-S** *socket_path*] [**-s**] [**-t** *type*] *mailbox*

The **mailbox path** command returns the filesystem path for the given
mailbox. By default, this is the path to the "index" directory.

**-t** *type*
: Output the path to this mailbox location type. One of:

- **alt-dir**
- **alt-mailbox**
- **control**
- **dir**
- **index** (DEFAULT)
- **index-cache**
- **index-private**
- **list-index**
- **mailbox**

*mailbox*
: The mailbox to query (mandatory).

### mailbox rename

**doveadm** [*GLOBAL OPTIONS*] mailbox rename [**-A** | **-u** *user* | **-F** *file* | **\-\-no-userdb-lookup**] [**-S** *socket_path*] [**-s**] *old_name* *new_name*
Expand Down

0 comments on commit 4bfafbf

Please sign in to comment.