Skip to content

Master Accounts

This feature is useful for administrative tasks like hot backups.

Note

This feature is presently not supported with ACCOUNT_PROVISIONER=LDAP.

Info

A Master Account:

  • Can login as any user (DMS account) and access their mailbox.
  • Is not associated to a separate DMS account, nor is it a DMS account itself.

setup CLI support

Use the setup dovecot-master <add|update|del|list> commands. These are roughly equivalent to the setup email subcommands.

Config file: docker-data/dms/config/dovecot-masters.cf

The config format is the same as postfix-accounts.cf for ACCOUNT_PROVISIONER=FILE.

The only difference is the account field has no @domain-part suffix, it is only a username.

Technical Details

The Master Accounts feature in DMS configures the Dovecot Master Users feature with the Dovecot setting auth_master_user_separator (where the default value is *).

Login via Master Account

Info

To login as another DMS account (user@example.com) with POP3 or IMAP, use the following credentials format:

  • Username: <LOGIN USERNAME>*<MASTER USER> (user@example.com*admin)
  • Password: <MASTER PASSWORD>

Verify login functionality

In the DMS container, you can verify with the testsaslauthd command:

# Prerequisites:
# A regular DMS account to test login through a Master Account:
setup email add user@example.com secret
# Add a new Master Account:
setup dovecot-master add admin top-secret

# Login with credentials format as described earlier:
testsaslauthd -u 'user@example.com*admin' -p 'top-secret'

Alternatively, any mail client should be able to login the equivalent credentials.