emailengine-app 1.14.8 → 2.60.1

package/LICENSE_EMAILENGINE.txt

@@ -0,0 +1,110 @@
+# EMAILENGINE LICENSE AGREEMENT
+
+> Version 2.1, 17 October 2023
+
+**PLEASE CAREFULLY READ THIS EMAILENGINE LICENSE AGREEMENT ("AGREEMENT"). THIS AGREEMENT CONSTITUTES A LEGALLY BINDING AGREEMENT BETWEEN YOU AND POSTAL SYSTEMS OÜ AND GOVERNS YOUR USE OF THE SOFTWARE (DEFINED BELOW). IF YOU DO NOT AGREE WITH THIS AGREEMENT, YOU MAY NOT USE THE SOFTWARE. IF YOU ARE USING THE SOFTWARE ON BEHALF OF A LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE AUTHORITY TO AGREE TO THIS AGREEMENT ON BEHALF OF SUCH ENTITY. IF YOU DO NOT HAVE SUCH AUTHORITY, DO NOT USE THE SOFTWARE IN ANY MANNER.**
+
+This Agreement is entered into by and between Postal Systems OÜ and you, or the legal entity on behalf of whom you are acting (as applicable, "You" or "Your").
+
+**1. DEFINITIONS**
+
+* 1.1. "Postal Systems OÜ" refers to the entity providing the EmailEngine software.
+* 1.2. "Software" refers to the EmailEngine application, including all its versions, updates, modifications, accompanying documentation, and related materials.
+* 1.3. "You" or "User" refers to the individual or entity installing, accessing, or using the Software.
+* 1.4. "License Key" refers to the unique code provided by Postal Systems OÜ upon purchasing a subscription which activates the full features of the Software beyond the trial period.
+* 1.5. "Instance" refers to a copy of EmailEngine run on a local machine or on a server. A single instance runs on a single machine but can utilize multiple CPU cores without limitations.
+
+**2. GRANT OF LICENSE**
+
+* 2.1. Postal Systems OÜ grants You a revocable, non-exclusive, non-transferable, limited license to download, install, and use the Software for a 14-day free trial period.
+* 2.2. Upon purchase of a subscription from https://postalsys.com, You are entitled to generate and use License Keys for the Software. The paid subscription covers all versions of EmailEngine and all updates and modifications.
+* 2.3. Once the trial period concludes, the core functionality of the Software ceases to operate until a valid License Key is provided.
+* 2.4. This license grants you the right to use the Software for both personal and commercial purposes.
+
+**3. TRIAL PERIOD**
+
+* 3.1. The Software can be used freely with all its features for a period of 14 days from the first installation.
+* 3.2. After the trial period expires, the Software will require a License Key to operate.
+* 3.3. Postal Systems OÜ reserves the right to offer extensions or variations of the trial period on a case-by-case basis.
+
+**4. LICENSE KEYS**
+
+* 4.1. License Keys can be generated by users or organizations that have an active subscription from Postal Systems OÜ. These License Keys can be reused within the purchasing organization without limitations.
+* 4.2. Distribution or sharing of License Keys to third parties, not associated with the purchasing user's organization, is strictly prohibited.
+
+**5. USE OF SOFTWARE AND COMPONENTS**
+
+* 5.1. You may only run the Software for Your benefit and for the internal operations of Your organization.
+* 5.2. The Software includes various components, including open-source software components. While Postal Systems OÜ facilitates the provision of these components, it does not provide any warranties regarding these components and is not responsible for any issues that may arise from their use. The respective licenses for these open-source components are included with the Software's documentation and must be followed as required.
+* 5.3. Extension of Services to Your Customers: You are permitted to use the Software under your existing subscription to extend services to your customers, provided that you maintain direct management over the EmailEngine instances. Your customers are permitted to use the EmailEngine as end users. However, they are expressly prohibited from developing their own services atop the EmailEngine platform or using modified source code for unauthorized purposes.
+
+**6. SOURCE CODE USAGE**
+
+* 6.1. You are permitted to view, copy, and modify the Software's source code, as made available by Postal Systems OÜ, solely for Your internal business use and in compliance with this Agreement's terms.
+* 6.2. Any modifications to the source code do not grant you any ownership rights to the original Software or any modifications. All rights, title, and interest to the Software and its source code remain exclusively with Postal Systems OÜ.
+* 6.3. You are strictly prohibited from altering, removing, or in any way tampering with the license key validation system within the Software. Any such unauthorized modifications will be considered a material breach of this Agreement and may result in legal action.
+* 6.4. You are required to use valid License Keys issued by Postal Systems OÜ to run the Software, including any modified versions. Any attempts to bypass the License Key requirement is a violation of this Agreement.
+
+**7. EXPIRATION OF LICENSE KEYS**
+
+* 7.1. License Keys are bound to the subscription period. Should your subscription expire, all License Keys generated by you or your organization will become invalid after 30 days from the subscription expiration date.
+* 7.2. Any instance of the Software using such an expired key will cease to function after the aforementioned 30-day period.
+
+**8. TERMINATION**
+
+* 8.1. Postal Systems OÜ reserves the right to terminate your license to use the Software if you violate any terms of this EULA.
+* 8.2. In the event of a termination, you will be provided with a written notice, sent to the email address used during your subscription to the EmailEngine, outlining the reasons for the termination.
+* 8.3. Upon termination, all rights granted to you under this EULA will cease, and you must promptly cease all use of the Software.
+
+**9. LIMITATION OF LIABILITY**
+
+* 9.1. Postal Systems OÜ shall not be responsible for any indirect damages, losses, or expenses that may arise from your use or misuse of the Software.
+* 9.2. Postal Systems OÜ’s liability for direct damages arising from or related to your use of the Software shall be limited to a maximum aggregate amount of 50€ over the life of the software usage.
+
+**10. GOVERNING LAW & JURISDICTION**
+
+* 10.1. This EULA shall be governed by and construed under the laws of Estonia.
+* 10.2. Any disputes arising from or related to this EULA shall be resolved in the jurisdiction of Tallinn, Estonia.
+
+**11. DATA PROTECTION & PRIVACY**
+
+* 11.1. By using the Software, you consent to the collection, processing, and use of any personal data as required for the functionality of the Software. The specifics of data handling and storage will be outlined in the company's Privacy Policy, which can be accessed on the company's website.
+
+**12. ACCEPTANCE**
+
+* 12.1. By downloading, installing, or using the EmailEngine software, even without explicitly clicking on an "I Agree" button or a similar mechanism, you acknowledge that you have read, understood, and agreed to be bound by the terms and conditions of this EULA.
+
+**13. ASSIGNMENT**
+
+* 13.1. This EULA and the rights granted hereunder may not be transferred or assigned by you but may be assigned by Postal Systems OÜ without restriction.
+
+**14. SEVERABILITY**
+
+* 14.1. If any provision of this EULA is held to be unenforceable or invalid for any reason, that provision shall be reformed to the extent necessary to make it enforceable and consistent with the intent of the parties, and the remaining provisions shall remain in full force and effect.
+
+**15. SUPPORT AND MAINTENANCE**
+
+* 15.1. Postal Systems OÜ does not guarantee any form of support for the Software.
+* 15.2. Users are solely responsible for the maintenance, operation, and management of their own EmailEngine instances.
+* 15.3. While Postal Systems OÜ may endeavor to provide support, if possible, such support will be facilitated through a public chat channel or via email communication.
+* 15.4. There are no guaranteed response times associated with any support inquiries or issues raised by users.
+
+**16. ENTIRE AGREEMENT**
+
+* 16.1. This EULA constitutes the entire agreement between you and Postal Systems OÜ regarding the Software and supersedes any prior or contemporaneous understandings, agreements, or representations, whether written or oral.
+
+**17. DISCLAIMERS AND WARRANTIES**
+
+* 17.1. The Software is provided "AS IS" and "AS AVAILABLE", without warranty of any kind, either express or implied, including, without limitation, warranties of merchantability, fitness for a particular purpose, and non-infringement. Postal Systems OÜ does not warrant that the Software will be error-free, that access thereto will be uninterrupted, or that defects will be corrected.
+
+**18. INDEMNIFICATION**
+
+* 18.1. You agree to indemnify, defend, and hold harmless Postal Systems OÜ, its officers, directors, employees, agents, licensors, suppliers, and any third-party information providers from and against all claims, losses, expenses, damages, and costs, including reasonable attorneys' fees, resulting from any violation of this EULA or any activity related to your use or misuse of the Software (including negligent or wrongful conduct).
+
+**19. FORCE MAJEURE**
+
+* 19.1. Neither party shall be in default or otherwise liable for any delay in or failure of its performance under this EULA if such delay or failure arises by any reason of any event beyond the reasonable control of a party, including acts of God, the elements, earthquakes, floods, fires, epidemics, riots, failures or delays in transportation or communications, or any act or failure to act by the other party or such other party’s officers, employees, agents, or contractors. The parties will promptly inform and consult with each other as to any of the above causes which, in their judgment, may or could be the cause of a delay in the performance of this EULA.
+
+Postal Systems OÜ  
+Tallinn, Estonia  
+All Rights Reserved.

package/README.md

@@ -1,410 +1,138 @@
-![twitter_header_photo_2](https://user-images.githubusercontent.com/132242/127487204-e27c980b-04b5-448c-b92f-e692fbefc1c5.png)
+![EmailEngine Logo](https://raw.githubusercontent.com/postalsys/emailengine/master/static/logo/EmailEngine_logo_vert.png)
 
 # EmailEngine Email API
 
----
+A headless email client application that provides access to IMAP, SMTP, Gmail API, and MS Graph API resources via a unified REST API. Easily integrate email accounts with your service!
 
-> **NB!** Version 1 of EmailEngine has been discontinued. Check out the [EmailEngine's homepage](https://emailengine.app) for version 2 and newer.
+-   Full documentation: [EmailEngine.app](https://emailengine.app/)
 
----
+> [!WARNING]
+> EmailEngine is not free open-source software. It is "source available" software, meaning you can view and copy the source code, but you need a <a href="https://postalsys.com/plans">paid subscription</a> to run it beyond the free 14-day trial. Each EmailEngine instance comes with this trial, so you can test EmailEngine without any commitment.
 
-Headless email client that makes IMAP and SMTP resources available over REST. Integrate email accounts with your service with ease!
+## Use Cases
 
-## Use cases
-
--   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](https://docs.emailengine.app/measuging-inbox-spam-placement/) 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
+-   Sync users' emails with your service and send emails on their behalf.
+-   Integrate your app with a dedicated email account, such as your support email.
+-   [Monitor INBOX and Junk folders](https://docs.emailengine.app/measuging-inbox-spam-placement/) of a test email account to track where sent emails land.
+-   Ideal for lightweight webmail and mobile email apps that prefer to avoid direct IMAP and MIME processing.
 
 ## Quickstart
 
-> This example assumes that [Redis](https://redis.io/) is installed locally and does not require any authentication. See [docs](https://github.com/postalsys/emailengine#redis-connection) for other options.
-
-1. Set up Postal System's NPM registry (requires a subscription that you can sign up for [here](https://postalsys.com/join))
+-   [Setup Instructions](https://emailengine.app/set-up)
 
-```
-$ npm set @postalsys:registry https://registry.postalsys.com
-$ npm adduser --registry=https://registry.postalsys.com --scope=@postalsys
-```
-
-2. Install and run EmailEngine
-
-```
-$ npm install -g @postalsys/emailengine-app
-$ emailengine
-```
-
-3. Open http://127.0.0.1:3000 in your browser
-
-Later, when you want to upgrade, just run the installation command from step 2. again and restart the _emailengine_ service.
+## Screenshots
 
-> **Tip** For human readable logs you can use _pino-pretty_ (`npm install -g pino-pretty`) by piping EmailEngine output to it: `emailengine | pino-pretty`
+![Screenshot 1](https://cldup.com/dC_4_suWrh.png)
+![Screenshot 2](https://cldup.com/KibGXRw8Mm.png)
+![Screenshot 3](https://cldup.com/mCxzWWjcLL.png)
 
-## Version and license
+## Version and License
 
-Run the following command to see the version and license information both for EmailEngine and for the included modules.
+Run the following command to check the version and license information for both EmailEngine and its included modules:
 
-```
+```bash
 $ emailengine license
 ```
 
-## Demo
-
-[![Using EmailEngine](https://img.youtube.com/vi/shHZHowVnYw/0.jpg)](https://www.youtube.com/watch?v=shHZHowVnYw)
-
-This video shows how to
-
-1. Install and start EmailEngine
-2. Configure webhooks destination using the web UI (webhook handling from https://webhook.site/)
-3. Create a new email account at https://ethereal.email/
-4. Open Swagger documentation page that also serves as an API playground
-5. Using the API playground to add a new IMAP/SMTP account using the id "example"
-6. Check the webhook listing to see the notification about found messages from the added account (includes limited information)
-7. Using the ID from the webhook fetch all data for the message (decoded addresses, subject, text etc, also original headers as an array)
-
-## Features
-
--   EmailEngine allows simple access to IMAP accounts via REST based API. No need to know IMAP or MIME internals, you get a "normal" API with paged message listings.
--   All text (that is subjects, email addresses, text and html content etc) is utf-8. Attachments are automatically decoded to binary representation.
--   Whenever something happens on tracked accounts EmailEngine posts notification over a webhook. This includes new messages, deleted messages and message flag changes.
--   Easy email sending. If you specify the message you are responding to or forwarding then EmailEngine sets all required headers, updates references message's flags in IMAP and also uploads message to the Sent Mail folder after sending.
--   No data ever leaves your system (read about data and security compliance [here](https://docs.emailengine.app/data-compliance/))
--   If you are running into IP based rate limiting then EmailEngine can make use of multiple local network interfaces to make connections from different IP addresses.
-
 ## Requirements
 
--   **Redis** – any version
--   **Node.js** - v12.16.0 or newer
+-   **Redis** - Any version
 
-There is no official [Redis](https://redis.io/) release for Windows but you can use an alternative like [Memurai](https://www.memurai.com/).
+> [!NOTE]
+> While Redis does not officially support Windows, alternatives like [Memurai](https://www.memurai.com/) are available.
 
-> **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,
+> [!TIP]
+> Minimize the latency between EmailEngine and Redis by running both on the same machine or in the same data center. Since EmailEngine runs a separate Redis command for each message in a folder during syncing, high latency can lead to slow sync times for folders with many messages.
 
 ## Documentation
 
 -   [API Reference](https://api.emailengine.app/)
--   [Blog posts](https://docs.emailengine.app/tag/email-engine/)
--   For Postman you can import OpenAPI specification [here](https://api.emailengine.app/swagger.json).
+-   [Blog Posts](https://docs.emailengine.app/tag/email-engine/)
+-   OpenAPI specification for Postman: [Swagger.json](https://api.emailengine.app/swagger.json)
 
 ## Configuring EmailEngine
 
-See the documentation for configuring EmailEngine [here](https://emailengine.app/configuration).
-
-#### Redis connection
-
-```
-$ emailengine --dbs.redis="redis://127.0.0.1:6379/8"
-```
-
-#### Prepared settings
-
-Read [here](https://emailengine.app/prepared-settings)
-
-#### Encryption secret
-
-Read [here](https://docs.emailengine.app/enabling-secret-encryption/)
-
-#### Local addresses
-
-Read [here](https://emailengine.app/local-addresses)
-
-#### Authentication
-
-EmailEngine supports Basic Auth with a single user. This is a convenience option only, for any kind of production use you should implement your own user management and limit access with a firewall to trusted machines only.
-
-```
-$ emailengine --api.auth="user:password"
-```
-
-## Screenshots
-
-**1. General overview**
-
-![](https://cldup.com/s3Vz9pwoIi.png)
-
-**2. Account states**
-
-![](https://cldup.com/F2G4m3FWUT.png)
-
-**3. Documentation**
-
-![](https://cldup.com/foHXymkVBw.png)
-
-**4. Settings**
-
-![](https://cldup.com/aZj55OpeCl.png)
-
-**5. Download stored logs**
-
-![](https://cldup.com/AqFCHZbVvL.png)
-
-**6. Swagger**
-
-![](https://cldup.com/mK0aS_uVfQ.png)
-
-## Webhooks
-
-EmailEngine sends webhooks to a predefined URL whenever something happens on an account.
-
-Easiest way to set it up would be to use the built in [web interface](http://127.0.0.1:3000). Open the <em>Settings</em> tab and set an URL for webhooks. You can also select specific events to listen for.
+Refer to the [configuration documentation](https://emailengine.app/configuration) for details on setting up EmailEngine.
 
-For example if flags are updated for a message you'd get a POST notification that looks like this:
+## App Access
 
-```json
-{
-    "account": "example",
-    "path": "[Google Mail]/All Mail",
-    "event": "messageUpdated",
-    "data": {
-        "id": "AAAAAQAAAeE",
-        "uid": 350861,
-        "changes": {
-            "flags": {
-                "added": ["\\Seen"]
-            }
-        }
-    }
-}
-```
-
-## API usage examples
-
-> See the entire API Reference [here](https://api.emailengine.app/)
-
-### Register an email account with EmailEngine
+By default, EmailEngine only allows connections from localhost. To enable external access, either edit the config file or use the CLI option `--api.host="0.0.0.0"`. Ensure to secure external access with a firewall or proxy to allow only trusted sources.
 
-When registering a new account you have to provide an unique account ID for it. This could be any text identifer, even an email address.
-
-> **NB!** Trying to create a new account with the same ID updates the existing account.
-
-```
-$ curl -XPOST "localhost:3000/v1/account" -H "content-type: application/json" -d '{
-    "account": "example",
-    "name": "My Example Account",
-    "imap": {
-        "host": "imap.gmail.com",
-        "port": 993,
-        "secure": true,
-        "auth": {
-            "user": "myuser@gmail.com",
-            "pass": "verysecret"
-        }
-    },
-    "smtp": {
-        "host": "smtp.gmail.com",
-        "port": 465,
-        "secure": true,
-        "auth": {
-            "user": "myuser@gmail.com",
-            "pass": "verysecret"
-        }
-    }
-}'
-```
-
-> This example uses a Gmail account but in reality it might be difficult to get past Gmail's security restrictions. In this case use [OAuth2](https://docs.emailengine.app/setting-up-gmail-oauth2-for-imap-api/) instead of password authentication.
-
-### List some messages
-
-EmailEngine returns paged results, newer messages first. So to get the first page or in other words the newest messages in a mailbox folder you can do it like this (notice the "example" id string that we set earlier in the request URL):
-
-```
-$ curl -XGET "localhost:3000/v1/account/example/messages?path=INBOX"
-```
-
-In the response you should see a listing of messages.
-
-```json
-{
-    "page": 0,
-    "pages": 10,
-    "messages": [
-        {
-            "id": "AAAAAQAAAeE",
-            "uid": 481,
-            "date": "2019-10-07T06:05:23.000Z",
-            "size": 4334,
-            "subject": "Test message",
-            "from": {
-                "name": "Peter Põder",
-                "address": "Peter.Poder@example.com"
-            },
-            "to": [
-                {
-                    "name": "",
-                    "address": "andris@emailengine.app"
-                }
-            ],
-            "messageId": "<0ebdd7b084794911b03986c827128f1b@example.com>",
-            "text": {
-                "id": "AAAAAQAAAeGTkaExkaEykA",
-                "encodedSize": {
-                    "plain": 17,
-                    "html": 2135
-                }
-            }
-        }
-    ]
-}
-```
-
-When fetching next page, add `page` query argument to the URL. Pages are zero indexes so if the server shows that there are 10 pages in total, it means you can query from `page=0` to `page=9`. If you want longer pages, use `pageSize` query argument.
-
-```
-$ curl -XGET "localhost:3000/v1/account/example/messages?path=INBOX&page=5"
-```
+## Deployment
 
-### Send an email
+### Ubuntu or Debian
 
-The following is an example of how to send a reply. In this case you should specify a reference message you are replying to (NB! this message must exist). Use the "id" from message listing as the "reference.message" value.
+You can use the included install script to set up:
 
-If referenced message was not found from the IMAP account then API responds with a 404 error and does not send out the reply.
+-   EmailEngine as a SystemD service
+-   Caddy as a reverse proxy and HTTPS certificate handler
 
+```bash
+$ wget https://raw.githubusercontent.com/postalsys/emailengine/master/install.sh
+$ chmod +x install.sh
+$ ./install.sh example.com
 ```
-curl -XPOST "localhost:3000/v1/account/example/submit" -H "content-type: application/json" -d '{
-    "reference": {
-        "message": "AAAAAQAAAeE",
-        "action": "reply"
-    },
-    "from": {
-        "name": "Example Sender",
-        "address": "sender@example.com"
-    },
-    "to": [{
-        "name": "Andris Reinman",
-        "address": "andris@emailengine.app"
-    }],
-    "text": "my reply to you",
-    "html": "<p>my reply to you</p>",
-    "attachments": [
-        {
-            "filename": "checkmark.png",
-            "content": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0lEQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC"
-        }
-    ]
-}'
-```
-
-**NB!** if you are sending a standalone email then you most probably want to set `subject` value as well. For replies and forwards, EmailEngine sets subject itself, based on the referenced message.
-
-**When sending a referenced message:**
-
--   EmailEngine sets correct In-Reply-To and Referenced message headers to the outgoing message
--   If subject is not set, then EmailEngine derives it from the referenced message and adds Re: or Fwd: prefix to it
--   EmailEngine sets `\Answered` flag to the referenced message
 
-**For all messages:**
+Where **example.com** is the domain name for EmailEngine.
 
--   EmailEngine uploads sent message to Sent Mail folder (if the folder can be detected automatically)
--   EmailEngine does not upload to Sent Mail folder when the account is Gmail/GSuite as Gmail does this automatically
--   If account is created with `copy: false` option, then emails are not copied to Sent Mail folder
+> [!NOTE]
+> Tested on Ubuntu 20.04 and Debian 11. Other versions may not be supported.
 
-## Using OAuth2
-
-Recommended approach for OAuth2 would be to manage access tokens outside of EmailEngine by running an authentication server. In this case whenever EmailEngine needs to authenticate an OAuth2 account, it makes a HTTP request to that authentication server. This server is responsible of respoding with a valid access token for EmailEngine to use.
-
-You can find an example authentication server implementation from [examples/auth-server.js](examples/auth-server.js).
-
-Alternatively, for Gmail only, you can use EmailEngine as the OAuth2 handler. In this case you would have to provide OAuth2 client id and client secret to EmailEngine (see OAuth2 section in the Settings page) and then, when adding new accounts, use the OAuth2 option instead of manually specifying IMAP and SMTP settings.
-
-In any case, your OAuth2 application for Gmail must support the following scope: `"https://mail.google.com/"`.
-
-Gmail requires security auditing if you are using restricted OAuth2 scopes for public accounts but for internal accounts (eg. accounts in your own GSuite organization) and test accounts (up to 100 pre-defined accounts) you do not need any permissions.
-
-Instructions for setting up OAuth2 with EmailEngine can be found [here](https://docs.emailengine.app/setting-up-gmail-oauth2-for-imap-api/).
-
-#### To use authentication server:
-
--   You must set `useAuthServer:true` flag for the account settings and not set `auth` value
--   Set authentication server URL in the _Settings_ page, the same way you set the webhook URL
--   EmailEngine makes HTTP request against authentication server URL with 2 extra GET params: `account` and `proto`, eg `url?account=example&proto=imap`
--   Authentication server must respond with a correct JSON structure for this account
-
-**Register managed account**
-
-```
-curl -XPOST "localhost:3000/v1/account" -H "content-type: application/json" -d '{
-    "account": "ouath-user",
-    "name": "Example",
-    "imap": {
-        "host": "imap.gmail.com",
-        "port": 993,
-        "secure": true,
-        "useAuthServer": true
-    },
-    "smtp": {
-        "host": "smtp.gmail.com",
-        "port": 465,
-        "secure": true,
-        "useAuthServer": true
-    }
-}'
-```
-
-**Auth server response for OAuth2 accounts:**
-
-```json
-{
-    "user": "username@gmail.com",
-    "accessToken": "jhdfgsjfmbsdmg"
-}
-```
+### SystemD
 
-**Auth server response for password based accounts:**
+Learn more about running EmailEngine as a SystemD service [here](https://emailengine.app/system-d-service).
 
-```json
-{
-    "user": "username@gmail.com",
-    "pass": "verysecret"
-}
-```
+### Docker
 
-## App access
+![Docker Image Size](https://img.shields.io/docker/image-size/postalsys/emailengine/v2?label=Docker%20image%20size)
 
-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 to only allow trusted sources.
+To execute EmailEngine-CLI commands within a Docker container:
 
-## Deployment
+1. Exec into the container:
 
-### SystemD
+    ```bash
+    $ docker exec -it <container-id> /bin/sh
+    ```
 
-Read about running EmailEngine as a SystemD service [here](https://emailengine.app/system-d-service)
+2. Run commands using `./bin/emailengine.js`:
 
-### Docker
+    ```bash
+    $ node bin/emailengine.js <command>
+    ```
 
-See the documentation for using EmailEngine with Docker [here](https://emailengine.app/docker).
+For full Docker usage documentation, visit [here](https://emailengine.app/docker).
 
-## Resolving issues with Redis
+## 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.
+EmailEngine relies on Redis as its data store. Redis stores everything in RAM, so if an issue arises, EmailEngine may flood Redis, rendering the app unusable if space runs out.
 
-First thing to do is to check what is actually going on. EmailEngine provides a few tools for that:
+To diagnose problems:
 
-1. Check Bull queues in Redis. You can use the built in [Arena UI](#bull-arena-settings) to view the state of the queues (Arena is not enabled by default). Open [http://127.0.0.1:3001/](http://127.0.0.1:3001/) in your browser to see the queues.
-2. 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):
+1. **Check Bull Queues:** Use the built-in Bull Arena UI to monitor queue states at [http://127.0.0.1:3000/admin/bull-board](http://127.0.0.1:3000/admin/bull-board).
+2. **Scan Keyspace:** Run the following to group Redis keys by type and generate a report:
 
-```
-$ emailengine scan > keyspace.csv
-```
+    ```bash
+    $ emailengine scan > keyspace.csv
+    ```
 
 ## Monitoring
 
-There is a Prometheus output available at `/metrics` URL path of the app.
+EmailEngine provides Prometheus metrics, available at the `/metrics` URL path.
 
-## Log analysis
+## Log Analysis
 
-Read about logging options [here](https://emailengine.app/logging)
+For information on logging options, read the documentation [here](https://emailengine.app/logging).
 
-## Security and Data compliance
+To trace IMAP traffic for a specific account, use the following command:
 
-[Read here](https://docs.emailengine.app/data-compliance/).
+```bash
+$ npm run raw -- --filter.account=account1
+```
 
-## Changelog
+## Security and Data Compliance
 
-Changelog is available for Postal Systems subscribers [here](https://postalsys.com/changelog/package/emailengine-app).
+For detailed security and data compliance information, refer to [this guide](https://docs.emailengine.app/data-compliance/).
 
 ## Licensing
 
-Licensed under GNU Affero General Public License v3.0 or later.
-
-MIT-licensed version of EmailEngine is available for [Postal Systems subscribers](https://postalsys.com/).
+EmailEngine is licensed under the commercial [EmailEngine License](./LICENSE_EMAILENGINE.txt).

package/app.json

@@ -0,0 +1,40 @@
+{
+    "name": "EmailEngine",
+    "description": "Headless email client that allows access to any email account over a REST API.",
+    "logo": "https://emailengine.app/lib_pTNsKLAHHUZrxQKE/6etgoat1wj19t5o5.png?w=160",
+    "website": "https://emailengine.app/",
+    "repository": "https://github.com/postalsys/emailengine",
+    "keywords": ["SMTP", "IMAP", "REST", "Email API", "email"],
+    "image": "heroku/nodejs",
+
+    "success_url": "/admin",
+    "addons": ["heroku-redis:premium-0"],
+
+    "env": {
+        "EENGINE_SECRET": {
+            "description": "Encryption secret. Setting this value encrypts account passwords and other secrets stored in Redis. Do not change once configured.",
+            "generator": "secret",
+            "required": false
+        },
+        "EENGINE_TIMEOUT": {
+            "description": "Time to wait until an IMAP command is aborted. IMAP is single-threaded, so new API requests must wait until previous ones have finished. Requests that wait too long are aborted.",
+            "value": "10s",
+            "required": false
+        },
+        "EENGINE_WORKERS": {
+            "description": "The number of IMAP workers to run. Increasing this value requires an upgraded plan as you would run out of allowed Redis connections when using the free Heroku Redis add-on.",
+            "value": "1",
+            "required": true
+        },
+        "EENGINE_HOST": {
+            "description": "IP address to bind to. Set it to \"0.0.0.0\", otherwise Heroku can not access the application.",
+            "value": "0.0.0.0",
+            "required": true
+        },
+        "NODE_TLS_REJECT_UNAUTHORIZED": {
+            "description": "Disable TLS certificate validation. Sorry for this, but otherwise EmailEngine is not able to connect to the Heroku Redis addon.",
+            "value": "0",
+            "required": true
+        }
+    }
+}