📄️ Overview
The Stalwart Command Line Interface (CLI) allows system administrators to perform tasks such as managing queues, migrating information and more.
📄️ Manage Queue
The SMTP message queue is managed using the queue CLI command which accepts the following arguments:
📄️ Manage Reports
Stalwart SMTP maintains a separate queue for DMARC and TLS aggregate reports until they are ready to delivered. Once a report is ready to be delivered, it is attached to an RFC5322 message and placed in the main message queue. The report queue is managed using the report CLI command which accepts the following arguments:
📄️ Manage Database
The message store is designed to be largely self-sufficient, requiring minimal maintenance from administrators. However, there are certain tasks that necessitate manual intervention. These tasks include operations such as deleting accounts or renaming them. While these actions do need to be done manually, they can also be automated through the use of the HTTP API.
🗃️ Import
2 items
📄️ Export
The command-line interface (CLI) tool supports exporting JMAP accounts, which allows system administrator to perform comprehensive backups or transfer user data to other mail servers. The exported data is stored in JSON files, which are structured according to the JMAP schema. This standardized format ensures compatibility and interoperability across different systems and platforms that support the JMAP protocol. An exported JMAP account is not limited to only the emails of the user, but it also includes mailboxes, Sieve scripts, identities, and vacation responses. This means that all critical account information, settings, and data are encapsulated within the export.
📄️ Backup
The backup procedure for Stalwart Mail Server varies depending on the chosen database and blob storage backend. Ensuring regular backups of your data will minimize the risk of data loss and aid in recovery in case of accidental deletion or system failures.
📄️ Migrate
When transitioning from an older version of the Stalwart Mail Server or switching the database backend (such as moving from SQLite to FoundationDB), data migration becomes a necessary step. This ensures that user account information, emails, and settings are accurately transferred and preserved in the new environment.