feat: added IMAP support (~73% code coverage), license update (BUSL-1…

….1 and MPL-2.0) 🚀 🎉

.commitlintrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   extends: ['@commitlint/config-conventional']
 };

.copywrite.hcl

@@ -0,0 +1,17 @@
+schema_version = 1
+
+project {
+  license = "BUSL-1.1"
+  copyright_holder = "Forward Email LLC"
+  header_ignore = [
+    "app/models/journals.js",
+    "app/models/mailboxes.js",
+    "app/models/messages.js",
+    "app/models/threads.js",
+    "helpers/imap-notifier.js",
+    "helpers/imap/**",
+    "helpers/socket-error.js",
+    "imap-server.js",
+    "test/imap/**"
+  ]
+}

.env.defaults

@@ -154,6 +154,13 @@ EMAILS_MONGO_PORT=27017
 EMAILS_MONGO_NAME=forwardemail_emails_{{NODE_ENV}}
 EMAILS_MONGO_URI="mongodb://{{EMAILS_MONGO_HOST}}:{{EMAILS_MONGO_PORT}}/{{EMAILS_MONGO_NAME}}"
 
+IMAP_MONGO_USER=
+IMAP_MONGO_PASS=
+IMAP_MONGO_HOST=localhost
+IMAP_MONGO_PORT=27017
+IMAP_MONGO_NAME=forwardemail_imap_{{NODE_ENV}}
+IMAP_MONGO_URI="mongodb://{{IMAP_MONGO_HOST}}:{{IMAP_MONGO_PORT}}/{{IMAP_MONGO_NAME}}"
+
 ###########
 ## redis ##
 ###########
@@ -183,6 +190,11 @@ MANDARIN_REDIS_USERNAME={{REDIS_USERNAME}}
 MANDARIN_REDIS_PORT={{REDIS_PORT}}
 MANDARIN_REDIS_HOST={{REDIS_HOST}}
 MANDARIN_REDIS_PASSWORD={{REDIS_PASSWORD}}
+IMAP_REDIS_TLS={{REDIS_TLS}}
+IMAP_REDIS_USERNAME={{REDIS_USERNAME}}
+IMAP_REDIS_PORT={{REDIS_PORT}}
+IMAP_REDIS_HOST={{REDIS_HOST}}
+IMAP_REDIS_PASSWORD={{REDIS_PASSWORD}}
 
 #############
 ## certbot ##
@@ -253,6 +265,7 @@ API_RESTRICTED_SYMBOL=API_RESTRICTED_SYMBOL
 ##########################
 ## smtp mirrored config ##
 ##########################
+SMTP_ALLOW_INSECURE_AUTH=false
 SMTP_TRANSPORT_USER="{{EMAIL_DEFAULT_FROM_EMAIL}}"
 SMTP_TRANSPORT_PASS=""
 SMTP_TRANSPORT_HOST={{SMTP_HOST}}
@@ -265,6 +278,12 @@ SMTP_EXCHANGE_DOMAINS=mx1.forwardemail.net,mx2.forwardemail.net
 TRUTH_SOURCES=
 MAX_RECIPIENTS=50
 
+##########
+## imap ##
+##########
+IMAP_HOST=localhost
+IMAP_PORT=2143
+
 #####################
 ## email retention ##
 #####################

.env.schema

@@ -155,6 +155,13 @@ EMAILS_MONGO_PORT=
 EMAILS_MONGO_NAME=
 EMAILS_MONGO_URI=
 
+IMAP_MONGO_USER=
+IMAP_MONGO_PASS=
+IMAP_MONGO_HOST=
+IMAP_MONGO_PORT=
+IMAP_MONGO_NAME=
+IMAP_MONGO_URI=
+
 ###########
 ## redis ##
 ###########
@@ -179,6 +186,11 @@ MANDARIN_REDIS_TLS=
 MANDARIN_REDIS_PORT=
 MANDARIN_REDIS_HOST=
 MANDARIN_REDIS_PASSWORD=
+IMAP_REDIS_TLS=
+IMAP_REDIS_USERNAME=
+IMAP_REDIS_PORT=
+IMAP_REDIS_HOST=
+IMAP_REDIS_PASSWORD=
 
 #############
 ## certbot ##
@@ -248,16 +260,25 @@ API_RESTRICTED_SYMBOL=
 ##########################
 ## smtp mirrored config ##
 ##########################
+SMTP_ALLOW_INSECURE_AUTH=
 SMTP_TRANSPORT_USER=
 SMTP_TRANSPORT_PASS=
 SMTP_TRANSPORT_HOST=
 SMTP_TRANSPORT_PORT=
 SMTP_TRANSPORT_SECURE=
+SMTP_HOST=
+SMTP_PORT=
 SMTP_MESSAGE_MAX_SIZE=
 SMTP_EXCHANGE_DOMAINS=
 TRUTH_SOURCES=
 MAX_RECIPIENTS=
 
+##########
+## imap ##
+##########
+IMAP_HOST=
+IMAP_PORT=
+
 #####################
 ## email retention ##
 #####################

.lintstagedrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   '*.md,!test/snapshots/**/*.md,!test/**/snapshots/**/*.md,!locales/README.md':
     [(filenames) => filenames.map((filename) => `remark ${filename} -qfo`)],

.postcssrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   plugins: {
     'stylelint': {},

.prettierrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   plugins: [require('@prettier/plugin-pug')],
   singleQuote: true,

.pug-lintrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   extends: '@ladjs/pug-lint-config-lad',
 

.remarkrc.js

@@ -1,10 +1,16 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   plugins: [
     'preset-github',
     [
       'remark-license',
       {
-        file: 'https://github.com/forwardemail/forwardemail.net/blob/master/LICENSE'
+        file: 'https://github.com/forwardemail/forwardemail.net/blob/master/LICENSE.md',
+        heading: '## License'
       }
     ]
   ]

.stylelintrc.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   "extends": ["stylelint-config-recommended-scss"]
 };

.xo-config.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) Forward Email LLC
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 module.exports = {
   prettier: true,
   space: true,

.yamllint.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Forward Email LLC
+# SPDX-License-Identifier: BUSL-1.1
+
 ---
 extends: default