EmailEngine Email API
Headless email client application that makes IMAP and SMTP resources available over REST. Integrate email accounts with your service with ease!
- Syncing users' emails to your service and sending out emails on behalf of your users
- Integrating your app with a specific email account, eg. your support email
- Monitor INBOX and Junk folders of a test email account to see where the emails you send out end up in
- Lightweight webmail and mobile email apps that do not want to process IMAP and MIME
Version and license
Run the following command to see the version and license information both for EmailEngine and for the included modules.
$ emailengine license
- Redis – any version
Tip! Try to keep the latency between EmailEngine and Redis as low as possible, best if these would run in the same machine or at least in the same DC. EmailEngine runs a separate Redis command for each message in a folder when syncing messages, so if the latency is not low then it takes a long time to sync a folder with a lot of messages,
See the documentation for configuring EmailEngine here.
By default EmailEngine allows connections only from localhost. To change this either edit config file or use
--api.host="0.0.0.0" cli option. This would enable outside access, so you should use firewall or a proxy to only allow trusted sources.
Ubuntu or Debian
You can use the included install script to set up
- EmailEngine as a SystemD service
- Caddy as a reverse proxy and HTTPS certificate handler
$ wget https://raw.githubusercontent.com/postalsys/emailengine/master/install.sh $ chmod +x install.sh $ ./install.sh example.com
- example.com is the domain name for EmailEngine
NB! Tested with Ubuntu 20.04 and Debian 11. Might not work with other OS versions.
Read about running EmailEngine as a SystemD service here
See the documentation for using EmailEngine with Docker here.
Resolving issues with Redis
EmailEngine is using Redis as it's data store. Redis stores everything in RAM so if something weird happens, EmailEngine could flood Redis and make the app unusable once there is no available space left.
First thing to do is to check what is actually going on. EmailEngine provides a few tools for that:
- Check Bull queues in Redis. You can use the built in Bull Arena UI to view the state of the queues. Open http://127.0.0.1:3000/admin/arena in your browser to see the queues.
- Scan the used keyspace. EmailEngine provides a tool that groups keys by type. Run it like this (use the same config for DB as you are using for the main app):
$ emailengine scan > keyspace.csv
There is a Prometheus output available at
/metrics URL path of the app.
Read about logging options here
To start EmailEngine to trail the IMAP traffic of a specific account
$ npm run raw -- --filter.account=account1
Security and Data compliance
Licensed under the commercial EmailEngine License.