Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stalwartlabs/imap-to-jmap

IMAP4 to JMAP Proxy
https://github.com/stalwartlabs/imap-to-jmap

imap jmap proxy

Last synced: 26 days ago
JSON representation

IMAP4 to JMAP Proxy

Awesome Lists containing this project

README 

        
# ⚠️ Repository Archived ⚠️



**This repository has been archived and is no longer maintained.**



Development for this IMAP-to-JMAP proxy has been moved to the [Stalwart Mail Server repository](https://github.com/stalwartlabs/mail-server), where ongoing updates and improvements will take place.



Thank you for your interest and contributions!



--- 



## IMAP to JMAP Proxy Server



[![Test](https://github.com/stalwartlabs/imap-to-jmap/actions/workflows/test.yml/badge.svg)](https://github.com/stalwartlabs/imap-to-jmap/actions/workflows/test.yml)

[![Build](https://github.com/stalwartlabs/imap-to-jmap/actions/workflows/build.yml/badge.svg)](https://github.com/stalwartlabs/imap-to-jmap/actions/workflows/build.yml)

[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

[![](https://img.shields.io/discord/923615863037390889?label=Chat)](https://discord.gg/jVAuShSdNZ)

[![](https://img.shields.io/twitter/follow/stalwartlabs?style=flat)](https://twitter.com/stalwartlabs)



Stalwart IMAP is an open-source Internet Message Access Protocol server designed to be secure, fast, robust and scalable.

A JSON Meta Application Protocol (JMAP) backend such as [Stalwart JMAP](https://github.com/stalwartlabs/jmap-server) is required to use Stalwart IMAP (in other words, Stalwart

IMAP is an imap4-to-jmap proxy).



Key features:



- IMAP4 and ManageSieve 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 with support for [all extensions](https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml).

- Support for multiple IMAP extensions:

  - Access Control Lists (ACL) ([RFC 4314](https://datatracker.ietf.org/doc/html/rfc4314))

  - Conditional Store and Quick Resynchronization ([RFC 7162](https://datatracker.ietf.org/doc/html/rfc7162))

  - SORT and THREAD ([RFC 5256](https://datatracker.ietf.org/doc/html/rfc5256))

  - Message Preview Generation ([RFC 8970](https://datatracker.ietf.org/doc/html/rfc8970))

  - And [many other extensions](https://stalw.art/imap/development/rfc/#imap4-extensions)...

- JMAP proxy features:

  - Proxies IMAP4 and ManageSieve requests to JMAP requests.

  - High-availability and fault-tolerance support when using a [Stalwart JMAP](https://github.com/stalwartlabs/jmap-server) backend.

  - Full support for [JMAP Core](https://datatracker.ietf.org/doc/html/rfc8620), [JMAP Mail](https://datatracker.ietf.org/doc/html/rfc8621) and [JMAP for Sieve Scripts](https://www.ietf.org/archive/id/draft-ietf-jmap-sieve-12.html).

- Secure:

  - OAuth 2.0 [authorization code](https://www.rfc-editor.org/rfc/rfc8628) and [device authorization](https://www.rfc-editor.org/rfc/rfc8628) flows.

  - Rate limiting.

  - Memory safe (thanks to Rust).



## Support



If you are having problems running Stalwart IMAP, you found a bug or just have a question,

do not hesitate to reach us on [Github Discussions](https://github.com/stalwartlabs/imap-to-jmap/discussions),

[Reddit](https://www.reddit.com/r/stalwartlabs) or [Discord](https://discord.gg/jVAuShSdNZ).

Additionally you may become a sponsor to obtain priority support from Stalwart Labs Ltd.



## Testing



### Base tests



The base tests perform protocol compliance tests as well as basic functionality testing on 

different functions across the Stalwart IMAP code base. 

To run the base test suite execute:



```bash

cargo test

```



### IMAP4 tests



The IMAP test suite performs a full server functionaly test including compliance to the IMAP4rev2/rev1

protocols and its extensions. To run these tests a blank Stalwart JMAP installation is required to be running at

``http://127.0.0.1:8080``.



To run the IMAP test suite execute:



```bash

cargo test imap_tests -- --ignored

```



### Third-party tests



Stalwart IMAP's protocol compliance may be also tested with Dovecot's ImapTest:



- Download [ImapTest](https://www.imapwiki.org/ImapTest/Installation).

- Start a blank Stalwart JMAP instance on ``http://127.0.0.1:8080``.

- Create a test account.

- Run the compliance tests as follows:

    ```

    ./imaptest host= port= \

            user= pass= auth=100 \

            test=/src/tests/resources/imap-test/

    ```



Note: The tests distributed with ImapTest were slightly modified to support the

IMAP4rev2 specification.



### Stress tests



Stress testing Stalwart IMAP can be done with Dovecot's ImapTest:



- Download [ImapTest](https://www.imapwiki.org/ImapTest/Installation).

- Start a blank Stalwart JMAP instance on ``http://127.0.0.1:8080``.

- Create at least 3 test accounts, all using the same password. Store the account names in a file, one account per line.

- Run the stress tests as follows:

    ```

    ./imaptest host= port= \

            userfile= \

            pass= \

            mbox= \

            auth=100

    ```



### Fuzz



To fuzz Stalwart IMAP server with `cargo-fuzz` execute:



```bash

 $ cargo +nightly fuzz run imap_server

```



## License



Licensed under the terms of the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) as published by

the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

See [LICENSE](LICENSE) for more details.



You can be released from the requirements of the AGPLv3 license by purchasing

a commercial license. Please contact [email protected] for more details.

  

## Copyright



Copyright (C) 2020-2022, Stalwart Labs Ltd.