| docs

Appearance

Mail Commands ​

These commands help you manage mail server components and configurations in AdminBolt. The mail stack consists of Postfix (SMTP), Dovecot (IMAP/POP3), Rspamd (spam filtering), and mlmmj (mailing lists).

Mail Server ​

bolt-cli manage-mailserver ​

Manages the overall mail server installation and configuration.

Options: ​

  • --action: Action to perform - install, remove, or status (default: install)

Examples: ​

bash
bolt-cli manage-mailserver --action=install
bolt-cli manage-mailserver --action=status
bolt-cli manage-mailserver --action=remove

System Email Account ​

bolt-cli manage-system-email-account ​

Manages the panel's own mail accounts on the server hostname: system@<hostname>, which receives mail addressed to the server, and admin@<hostname>, the address the panel sends its own mail from. You open both from the Mailboxes tab of the Email area.

Options: ​

  • --action: Action to perform - install or remove (default: install)
  • --hostname: with --action=remove only, a hostname this server used before. Required for remove.

Setting up the accounts of the current hostname ​

bash
bolt-cli manage-system-email-account --action=install

Creates the two accounts for the current hostname, or gives them a new password when they already exist. A hostname change runs this for you.

Removing the accounts of a previous hostname ​

Since panel 1.9.3, a hostname change switches off system@ and admin@ of the previous hostname: they stop receiving mail and accepting logins, and their stored mail stays on the server. To remove them, name that hostname:

bash
bolt-cli manage-system-email-account --action=remove --hostname=old.example.com
  • Only system@ and admin@ of that hostname are removed. Their mail is never deleted: it is moved to a dated backup folder on the server, next to a list of what was moved, and the command prints where.
  • The mail domain of that hostname is removed only when nothing else is left in it and it is not a hosted domain. Otherwise it is kept, together with everything in it, and the command says why.
  • A mailbox of the same name that belongs to a hosting account is not touched.
  • The current hostname is refused, and so is a hostname the panel still sends its own mail as. In the second case, run bolt-cli manage-system-email-account --action=install first, then the removal again.

When something could not be removed, the command names each account or folder it kept and why, gives the next step, and exits with an error. Correct the cause and run it again.

The same removal is available in the admin REST API as POST /api/system-mailboxes/previous-hostnames/remove, with the hostname in the hostname field. See System mail of the previous hostname.

Postfix (SMTP) ​

bolt-cli manage-postfix ​

Manages Postfix installations and configurations (SMTP server for sending and receiving email).

Options: ​

  • --action: Action to perform - install, remove, or status (default: install)

Examples: ​

bash
bolt-cli manage-postfix --action=install
bolt-cli manage-postfix --action=status
bolt-cli manage-postfix --action=remove

bolt-cli manage-postfix-profiles ​

Applies or removes the default Postfix settings profile.

Options: ​

  • --action: Action to perform - install or remove (default: install)

Example: ​

bash
bolt-cli manage-postfix-profiles --action=install

Dovecot (IMAP/POP3) ​

bolt-cli manage-dovecot ​

Manages Dovecot installations and configurations (IMAP and POP3 server for email retrieval).

Options: ​

  • --action: Action to perform - install, remove, or status (default: install)

Examples: ​

bash
bolt-cli manage-dovecot --action=install
bolt-cli manage-dovecot --action=status
bolt-cli manage-dovecot --action=remove

bolt-cli manage-dovecot-profiles ​

Applies or removes the default Dovecot settings profile.

Options: ​

  • --action: Action to perform - install or remove (default: install)

Example: ​

bash
bolt-cli manage-dovecot-profiles --action=install

Rspamd (Spam Filtering) ​

bolt-cli manage-rspamd ​

Manages Rspamd installations and configurations (spam filtering and email security).

Options: ​

  • --action: Action to perform - install, remove, or status (default: install)

Examples: ​

bash
bolt-cli manage-rspamd --action=install
bolt-cli manage-rspamd --action=status
bolt-cli manage-rspamd --action=remove

bolt-cli manage-rspamd-profiles ​

Applies or removes the default Rspamd settings profile.

Options: ​

  • --action: Action to perform - install or remove (default: install)

Example: ​

bash
bolt-cli manage-rspamd-profiles --action=install

mlmmj (Mailing Lists) ​

bolt-cli manage-mlmmj ​

Manages mlmmj installations and configurations (mailing list manager).

Options: ​

  • --action: Action to perform - install, remove, or status (default: install)

Examples: ​

bash
bolt-cli manage-mlmmj --action=install
bolt-cli manage-mlmmj --action=status
bolt-cli manage-mlmmj --action=remove

bolt-cli manage-mlmmj-profiles ​

Applies or removes the default mlmmj settings profile.

Options: ​

  • --action: Action to perform - install or remove (default: install)

Example: ​

bash
bolt-cli manage-mlmmj-profiles --action=install