EmailEngine

EmailEngine enables email account access through a REST API by maintaining a constant IMAP connection with each account. It converts REST API requests into IMAP commands and closely monitors changes in these accounts.

This platform is an ideal solution for those who wish to create in-house IMAP and SMTP integrations for their services but prefer not to dive deep into the complexities of numerous RFC specifications.

Think of EmailEngine as a powerful email class library. While an IMAP library can help with basic tasks like displaying the current mailbox state, EmailEngine goes beyond this, providing more comprehensive support for complex operations.

Software Included

Creating an App using the Control Panel

Click the Deploy to DigitalOcean button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

Creating an App using the API

In addition to creating a Droplet from the EmailEngine 1-Click App using the control panel, you can also use the DigitalOcean API. As an example, to create a 4GB EmailEngine Droplet in the SFO2 region, you can use the following curl command. You need to either save your API access token) to an environment variable or substitute it in the command below.

curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image": "postalsystemso-emailengine"}' \
        "https://api.digitalocean.com/v2/droplets"

Getting Started After Deploying EmailEngine

1. Create an A-record for your domain name in your DNS, pointing to your droplet’s IP address
2. Use SSH to log in to your droplet and provide the requested domain name and admin password: ssh root@your_droplet_public_ipv4
3. Go to http://your_droplet_public_ipv4 and click the Manage EmailEngine button
4. Sign in to the web interface using the username “admin” and the password from step 2
5. After logging in, start your 14-day trial by clicking the Start a 14-day trial button

Next steps

1. Add your IMAP account information on the Accounts page to begin monitoring it
2. Generate an access token on the Access tokens page
3. Test some REST API requests on the API Reference page for the monitored account
4. To update EmailEngine to the latest version, execute the following command on the server: sudo /opt/upgrade-emailengine.sh