imapflow - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
-  "name": "imapflow",
-  "version": "1.0.0",
-  "description": "IMAP Client for Node",
-  "main": "lib/imapflow.js",
-  "scripts": {
-    "test": "grunt"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/andris9/imapflow.git"
-  },
-  "keywords": [],
-  "author": "Andris Reinman",
-  "license": "UNLICENSED",
-  "bugs": {
-    "url": "https://github.com/andris9/imapflow/issues"
-  },
-  "homepage": "https://github.com/andris9/imapflow#readme",
-  "devDependencies": {
-    "eslint": "^6.7.2",
-    "eslint-config-nodemailer": "^1.2.0",
-    "eslint-config-prettier": "^6.7.0",
-    "grunt": "^1.0.4",
-    "grunt-cli": "^1.3.2",
-    "grunt-contrib-nodeunit": "^2.0.0",
-    "grunt-eslint": "^22.0.0"
-  }
+    "name": "imapflow",
+    "version": "1.0.1",
+    "description": "IMAP Client for Node",
+    "main": "./lib/imap-flow.js",
+    "scripts": {
+        "test": "grunt",
+        "prepare": "npm run build",
+        "docs": "rm -rf docs && mkdir -p docs && jsdoc lib/imap-flow.js -c jsdoc.json -t ./node_modules/jsdoc-baseline -R README.md --destination docs/",
+        "dst": "jsdoc -t node_modules/tsd-jsdoc/dist -r lib/imap-flow.js --destination lib/",
+        "build": "npm run docs && npm run dst"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/nodemailer/imapflow.git"
+    },
+    "keywords": [
+        "imap",
+        "email",
+        "mail"
+    ],
+    "author": "Andris Reinman",
+    "license": "UNLICENSED",
+    "bugs": {
+        "url": "https://github.com/nodemailer/imapflow/issues"
+    },
+    "homepage": "https://imapflow.com/",
+    "devDependencies": {
+        "eslint": "6.8.0",
+        "eslint-config-nodemailer": "1.2.0",
+        "eslint-config-prettier": "6.9.0",
+        "grunt": "1.0.4",
+        "grunt-cli": "1.3.2",
+        "grunt-contrib-nodeunit": "2.0.0",
+        "grunt-eslint": "22.0.0",
+        "jsdoc": "3.6.3",
+        "jsdoc-baseline": "0.1.5",
+        "tsd-jsdoc": "2.4.0"
+    },
+    "dependencies": {
+        "encoding-japanese": "1.0.30",
+        "iconv-lite": "0.5.0",
+        "libbase64": "1.2.1",
+        "libmime": "4.2.1",
+        "libqp": "1.1.0",
+        "mailsplit": "4.6.3",
+        "pino": "5.16.0",
+        "utf7": "1.0.2"
+    }
 }

README.md

@@ -1,2 +0,63 @@
-# imapflow
-IMAP Client
+# ImapFlow
+
+IMAP Client for Node.js extracted from [NodemailerApp project](https://nodemailer.com/app/).
+
+The focus for ImapFlow is to provide easy to use API over IMAP.
+
+## Usage
+
+First install the module from npm:
+
+```
+$ npm install imapflow
+```
+
+next import the ImapFlow class into your script:
+
+```js
+const { ImapFlow } = require('imapflow');
+```
+
+All ImapFlow methods use Promises, so you need to wait using `await` or wait for the `then()` method to fire until you get the response.
+
+```js
+const { ImapFlow } = require('imapflow');
+const client = new ImapFlow({
+    host: 'ethereal.email',
+    port: 993,
+    secure: true,
+    auth: {
+        user: '[e-mail]',
+        pass: 'mW6e4wWWnEd3H4hT5B'
+    }
+});
+
+const main = async () => {
+    // wait until client connects and authorizes
+    await client.connect();
+
+    // select a mailbox
+    await client.mailboxOpen('INBOX');
+
+    // fetch latest message source
+    let message = await client.fetchOne('*', { source: true });
+    console.log(message.source.toString());
+
+    // log out and close connection
+    await client.logout();
+};
+
+main().catch(err => console.error(err));
+```
+
+## Documentation
+
+[API reference](https://imapflow.com/ImapFlow.html).
+
+ImapFlow has TS typings set for compatible editors.
+
+## License
+
+© 2020 Andris Reinman
+
+Licensed for evaluation use only

test/imapflow-test.js

 'use strict';
 
-const { ImapFlow } = require('../lib/imapflow');
+const { ImapFlow } = require('../lib/imap-flow');
 
@@ -5,0 +5,0 @@ module.exports['Create imapflow instance'] = test => {

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

392990

increased by21805.8%

Number of package files

55

increased by685.71%

Lines of code

9516

increased by28736.36%

Number of lines in readme file

64

increased by2033.33%

Worsened metrics

Dependency count

8

increased byInfinity%

Dev dependency count

10

increased by42.86%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

3

increased byInfinity%

Dependency changes

• + Addedencoding-japanese@1.0.30

• + Addediconv-lite@0.5.0

• + Addedlibbase64@1.2.1

• + Addedlibmime@4.2.1

• + Addedlibqp@1.1.0

• + Addedmailsplit@4.6.3

• + Addedpino@5.16.0

• + Addedutf7@1.0.2

• + Addedatomic-sleep@1.0.0(transitive)

• + Addedencoding-japanese@1.0.30(transitive)

• + Addedfast-redact@2.1.0(transitive)

• + Addedfast-safe-stringify@2.1.1(transitive)

• + Addedflatstr@1.0.12(transitive)

• + Addediconv-lite@0.5.0(transitive)

• + Addedlibbase64@1.2.1(transitive)

• + Addedlibmime@4.2.1(transitive)

• + Addedlibqp@1.1.0(transitive)

• + Addedmailsplit@4.6.3(transitive)

• + Addedpino@5.16.0(transitive)

• + Addedpino-std-serializers@2.5.0(transitive)

• + Addedquick-format-unescaped@3.0.3(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsemver@5.3.0(transitive)

• + Addedsonic-boom@0.7.7(transitive)

• + Addedutf7@1.0.2(transitive)