imapflow - npm Package Compare versions

Comparing version 1.0.9 to 1.0.10

CHANGELOG.md

 # CHANGELOG
 
+-   v1.0.10 - 2020-02-02
+
+    -   Use debug logging level for IMAP traffic
+
 -   v1.0.9 - 2020-02-02
@@ -4,0 +8,0 @@

lib/logger.js

 'use strict';
 
 const logger = require('pino')();
-
+logger.level = 'debug';
 module.exports = logger;

lib/types.d.ts

@@ -22,3 +22,3 @@ /// <reference types="node" />
      * @param {Boolean} [options.disableAutoIdle=false] if `true` then IDLE is not started automatically. Useful if you only need to perform specific tasks over the connection
-     * @param {Object} options.tls Additional TLS options (see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback") for all available options)
+     * @param {Object} options.tls Additional TLS options (see [Node.js TLS connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) for all available options)
      * @param {Boolean} [options.tls.rejectUnauthorized=true] if `false` then client accepts self-signed and expired certificates from the server
@@ -277,2 +277,3 @@ * @param {String} [options.tls.minVersion=TLSv1.2] latest Node.js defaults to *'TLSv1.2'*, for older mail servers you might need to use something else, eg *'TLSv1'*
          * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers
+         * @param {BigInt} [options.unchangedSince] If set then only messages with a lower or equal `modseq` value are updated. Ignored if server does not support `CONDSTORE` extension.
          * @returns {Promise<Boolean>} Did the operation succeed or not
@@ -287,2 +288,3 @@ *
             uid?: boolean;
+            unchangedSince?: bigint;
         }): Promise<Boolean>;
@@ -296,2 +298,3 @@ /**
          * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers
+         * @param {BigInt} [options.unchangedSince] If set then only messages with a lower or equal `modseq` value are updated. Ignored if server does not support `CONDSTORE` extension.
          * @returns {Promise<Boolean>} Did the operation succeed or not
@@ -306,2 +309,3 @@ *
             uid?: boolean;
+            unchangedSince?: bigint;
         }): Promise<Boolean>;
@@ -315,2 +319,3 @@ /**
          * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers
+         * @param {BigInt} [options.unchangedSince] If set then only messages with a lower or equal `modseq` value are updated. Ignored if server does not support `CONDSTORE` extension.
          * @returns {Promise<Boolean>} Did the operation succeed or not
@@ -325,2 +330,3 @@ *
             uid?: boolean;
+            unchangedSince?: bigint;
         }): Promise<Boolean>;
@@ -405,2 +411,10 @@ /**
          * let list = await client.search({seen: false});
+         * // use OR modifier (array of 2 or more search queries)
+         * let list = await client.search({
+         *   seen: false,
+         *   or: [
+         *     {flagged: true},
+         *     {from: 'andris'},
+         *     {subject: 'test'}
+         *   ]});
          */
@@ -407,0 +421,0 @@ search(query: SearchObject, options?: {

package.json

 {
     "name": "imapflow",
-    "version": "1.0.9",
+    "version": "1.0.10",
     "description": "IMAP Client for Node",
@@ -10,3 +10,3 @@ "main": "./lib/imap-flow.js",
         "prepare": "npm run build",
-        "docs": "rm -rf docs && mkdir -p docs && jsdoc lib/imap-flow.js -c jsdoc.json -R README.md --destination docs/",
+        "docs": "rm -rf docs && mkdir -p docs && jsdoc lib/imap-flow.js -c jsdoc.json -R README.md --destination docs/ && cp assets/favicon.ico docs",
         "dst": "node types.js",
@@ -13,0 +13,0 @@ "build": "npm run docs && npm run dst"

README.md

 # ImapFlow
 
-IMAP Client for Node.js extracted from [NodemailerApp project](https://nodemailer.com/app/).
+_IMAP Client for Node.js extracted from the [NodemailerApp project](https://nodemailer.com/app/)._
 
-The focus for ImapFlow is to provide easy to use API over IMAP.
+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.
 
+IMAP extensions are handled in the background, so for example you can always request `labels` value from a {@link FetchQueryObject|fetch()} call but if the IMAP server does not support `X-GM-EXT1` extension, then `labels` value is not included in the response.
+
 ## Source
@@ -8,0 +10,0 @@

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

465717

increased by4.27%

Number of package files

57

increased by1.79%

Lines of code

10632

increased by0.52%

Number of lines in readme file

80

increased by2.56%

Worsened metrics

Number of medium supply chain risk alerts

4

increased by33.33%

No dependency changes