imapflow 1.0.77 → 1.0.78

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+-   1.0.78 - 2021-11-28
+
+    -   Proxy support. Use configuration options `proxy: "url"` to use proxies
+
 -   1.0.77 - 2021-11-25
 
     -   Testing out proxy connections

package/README.md

@@ -1,6 +1,10 @@
 # ImapFlow
 
-_Node.js IMAP Client library built for for [EmailEngine Email API](https://emailengine.app/)._
+---
+
+> Managing IMAP connections is cool but if you are only looking for an easy way to integrate email accounts, then ImapFlow was built for [EmailEngine Email API](https://emailengine.app/). It's a self hosted software that converts all IMAP accounts to easy to use REST interfaces.
+
+---
 
 The focus for ImapFlow is to provide easy to use API over IMAP. Using ImapFlow does not expect knowledge about specific IMAP details, general understanding is good enough.
 

package/lib/imap-flow.js

@@ -126,6 +126,7 @@ class ImapFlow extends EventEmitter {
      * @param {Boolean} [options.logRaw=false] If true then log data read from and written to socket encoded in base64
      * @param {Boolean} [options.emitLogs=false] If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
      * @param {Boolean} [options.verifyOnly=false] If `true` then logs out automatically after successful authentication
+     * @param {Boolean} [options.proxy] Optional proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`) proxies
      */
     constructor(options) {
         super();

package/lib/types.d.ts

@@ -26,6 +26,7 @@ declare module "imapflow" {
      * @param [options.logRaw = false] - If true then log data read from and written to socket encoded in base64
      * @param [options.emitLogs = false] - If `true` then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
      * @param [options.verifyOnly = false] - If `true` then logs out automatically after successful authentication
+     * @param [options.proxy] - Optional proxy URL. Supports HTTP CONNECT (`http://`, `https://`) and SOCKS (`socks://`, `socks4://`, `socks5://`) proxies
      */
     class ImapFlow extends EventEmitter {
         constructor(options: {
@@ -50,6 +51,7 @@ declare module "imapflow" {
             logRaw?: boolean;
             emitLogs?: boolean;
             verifyOnly?: boolean;
+            proxy?: boolean;
         });
         /**
          * Current module version as a static class property

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.77",
+    "version": "1.0.78",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -49,7 +49,7 @@
         "libmime": "5.0.0",
         "libqp": "1.1.0",
         "mailsplit": "5.3.1",
-        "nodemailer": "6.7.1",
+        "nodemailer": "6.7.2",
         "pino": "7.4.1",
         "socks": "2.6.1"
     }