| docs

Appearance

Mail Commands ​

These commands help you manage mail server components and configurations in AdminBolt. The mail stack consists of several services: Postfix (SMTP), Dovecot (IMAP/POP3), Rspamd (spam filtering), and optional components like Exim, SpamAssassin, 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 system email accounts used for internal server communications (e.g., postmaster, admin).

Options: ​

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

Example: ​

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

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

Exim (Alternative MTA) ​

bolt-cli manage-exim ​

Manages Exim installations and configurations (alternative mail transfer agent).

Options: ​

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

Examples: ​

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

bolt-cli manage-exim-profiles ​

Applies or removes the default Exim settings profile.

Options: ​

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

Example: ​

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

SpamAssassin (Alternative Spam Filter) ​

bolt-cli manage-spamassassin ​

Manages SpamAssassin installations and configurations (alternative spam filtering solution).

Options: ​

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

Examples: ​

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

bolt-cli manage-spamassassin-profiles ​

Applies or removes the default SpamAssassin settings profile.

Options: ​

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

Example: ​

bash
bolt-cli manage-spamassassin-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