Added license.

CHANGELOG

@@ -0,0 +1,14 @@
+stalwart-mail 0.3.0
+================================
+- Merged the `stalwart-jmap`, `stalwart-imap` and `stalwart-smtp` repositories into
+  `stalwart-mail`.
+- Added support for **LDAP** and **SQL** authentication.
+- Added support for **subaddressing** and **catch-all** addresses.
+- Added support for **S3-compatible** storage.
+- Removed clustering module and replaced it with a **FoundationDB** backend option.
+- Integrated Stalwart SMTP into Stalwart JMAP.
+- Rewritten JMAP protocol parser.
+- Rewritten store backend.
+- Rewritten IMAP server to have direct access to the message store (no more IMAP proxy).
+- Replaced `actix` with `hyper`.
+

README.md

@@ -8,22 +8,61 @@
 
 **Stalwart Mail Server** is an open-source mail server solution with JMAP, IMAP4, and SMTP support and a wide range of modern features. It is written in Rust and designed to be secure, fast, robust and scalable.
 
-_Caveat emptor_: This repository is currently under active development and is not yet ready for production use. Please refer to the JMAP, IMAP and SMTP repositories if you would like to 
-try each of these servers individually:
+Key features:
 
-* [Stalwart JMAP Server](https://github.com/stalwartlabs/jmap-server/)
-* [Stalwart IMAP Server](https://github.com/stalwartlabs/imap-server/)
-* [Stalwart SMTP Server](https://github.com/stalwartlabs/smtp-server/)
+- **JMAP** server:
+  - JMAP Core ([RFC 8620](https://datatracker.ietf.org/doc/html/rfc8620))
+  - JMAP Mail ([RFC 8621](https://datatracker.ietf.org/doc/html/rfc8621))
+  - JMAP over WebSocket ([RFC 8887](https://datatracker.ietf.org/doc/html/rfc8887))
+  - JMAP for Sieve Scripts ([DRAFT-SIEVE-13](https://www.ietf.org/archive/id/draft-ietf-jmap-sieve-13.html))
+- **IMAP4** server:
+  - IMAP4rev2 ([RFC 9051](https://datatracker.ietf.org/doc/html/rfc9051)) full compliance.
+  - IMAP4rev1 ([RFC 3501](https://datatracker.ietf.org/doc/html/rfc3501)) backwards compatible.
+  - ManageSieve ([RFC 5804](https://datatracker.ietf.org/doc/html/rfc5804)) server.
+  - Numerous [extensions](https://stalw.art/docs/development/rfcs#imap4-and-extensions) supported.
+- **SMTP** server:
+  - Built-in [DMARC](https://datatracker.ietf.org/doc/html/rfc7489), [DKIM](https://datatracker.ietf.org/doc/html/rfc6376), [SPF](https://datatracker.ietf.org/doc/html/rfc7208) and [ARC](https://datatracker.ietf.org/doc/html/rfc8617) support for message authentication.
+  - Strong transport security through [DANE](https://datatracker.ietf.org/doc/html/rfc6698), [MTA-STS](https://datatracker.ietf.org/doc/html/rfc8461) and [SMTP TLS](https://datatracker.ietf.org/doc/html/rfc8460) reporting.
+  - Inbound throttling and filtering with granular configuration rules and Sieve scripting.
+  - Virtual queues with delayed delivery, priority delivery, quotas, routing rules and throttling support.
+- **Flexible**:
+  - **LDAP** directory and **SQL** database authentication.
+  - Full-text search available in 17 languages.
+  - Disk quotas.
+  - Sieve scripting language with support for all [registered extensions](https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml).
+  - Subaddressing and catch-all addresses support.
+  - Integration with **OpenTelemetry** to enable monitoring, tracing, and performance analysis.
+- **Secure**:
+  - OAuth 2.0 [authorization code](https://www.rfc-editor.org/rfc/rfc8628) and [device authorization](https://www.rfc-editor.org/rfc/rfc8628) flows.
+  - Access Control Lists (ACLs).
+  - Rate limiting.
+- **Robust and scalable**:
+  - **FoundationDB** or **SQLite** database backends.
+  - **S3-compatible** blob storage support.
+  - Memory safe (thanks to Rust).
 
-## Why choose Stalwart?
+## Get Started
 
-Within the field of mail servers, established names like Postfix, Courier and Dovecot have long been the go-to solutions. However, the landscape of internet messaging is evolving, with a need for more efficient, easy to maintain, reliable, and secure systems. Here's why you might consider making the switch to Stalwart Mail Server:
+Install Stalwart Mail Server on your server by following the instructions for your platform:
 
-- Designed with the latest internet messaging protocols in mind - JMAP and IMAP4rev2, along with the conventional SMTP. 
-- Leverages the performance and security benefits of the Rust programming language. This statically typed, compiled language is known for its memory safety and concurrency support, reducing the likelihood of typical security issues like buffer overflows.
-- Thanks to its native FoundationDB and S3 storage support, it can be scaled across many servers, accommodating millions of users.
-- Available as a single, integrated package that includes JMAP, IMAP, and SMTP servers. This means that you don't have to install, configure and maintain multiple servers to get a complete solution.
-- Designed to be easy to install and maintain, with a single configuration file and a simple command-line interface.
+- [Linux / MacOS](https://stalw.art/docs/install/linux)
+- [Windows](https://stalw.art/docs/install/windows)
+- [Docker](https://stalw.art/docs/install/docker)
+
+All documentation is available at [stalw.art/docs](https://stalw.art/docs).
+
+## Support
+
+If you are having problems running Stalwart Mail Server, you found a bug or just have a question,
+do not hesitate to reach us on [Github Discussions](https://github.com/stalwartlabs/mail-server/discussions),
+[Reddit](https://www.reddit.com/r/stalwartlabs) or [Discord](https://discord.gg/aVQr3jF8jd).
+Additionally you may become a sponsor to obtain priority support from Stalwart Labs Ltd.
+
+## Funding
+
+Part of the development of this project was funded through the [NGI0 Entrust Fund](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl/) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101069594.
+
+If you find the project useful you can help by [becoming a sponsor](https://github.com/sponsors/stalwartlabs). Thank you!
 
 ## License
 
@@ -36,4 +75,4 @@ a commercial license. Please contact licensing@stalw.art for more details.
 
 ## Copyright
 
-Copyright (C) 2020, Stalwart Labs Ltd.
+Copyright (C) 2023, Stalwart Labs Ltd.

crates/cli/src/main.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/cli/src/modules/cli.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/cli/src/modules/database.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use jmap_client::client::Credentials;
 use reqwest::header::AUTHORIZATION;
 

crates/cli/src/modules/export.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use std::{
     path::{Path, PathBuf},
     sync::Arc,

crates/cli/src/modules/import.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/cli/src/modules/mod.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/cli/src/modules/queue.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/cli/src/modules/report.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2020-2023, Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart Command Line Interface.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/directory/src/cache/config.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use std::{sync::Arc, time::Duration};
 
 use parking_lot::lock_api::Mutex;

crates/directory/src/cache/lookup.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use mail_send::Credentials;
 
 use crate::{Directory, Principal};

crates/directory/src/cache/lru.rs

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2023 Stalwart Labs Ltd.
  *
- * This file is part of the Stalwart SMTP Server.
+ * This file is part of Stalwart Mail Server.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as

crates/directory/src/cache/mod.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use parking_lot::Mutex;
 
 use crate::Directory;

crates/directory/src/config.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use bb8::{ManageConnection, Pool};
 use std::{
     fs::File,

crates/directory/src/imap/client.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use mail_send::Credentials;
 use smtp_proto::{
     request::{parser::Rfc5321Parser, AUTH},

crates/directory/src/imap/config.rs

@@ -1,3 +1,26 @@
+/*
+ * Copyright (c) 2023 Stalwart Labs Ltd.
+ *
+ * This file is part of Stalwart Mail Server.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ * in the LICENSE file at the top-level directory of this distribution.
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You can be released from the requirements of the AGPLv3 license by
+ * purchasing a commercial license. Please contact licensing@stalw.art
+ * for more details.
+*/
+
 use std::sync::Arc;
 
 use mail_send::smtp::tls::build_tls_connector;