Comparing version 1.0.60 to 1.0.63
{ | ||
"name": "imapflow", | ||
"version": "1.0.60", | ||
"version": "1.0.63", | ||
"description": "IMAP Client for Node", | ||
@@ -29,5 +29,5 @@ "main": "./lib/imap-flow.js", | ||
"devDependencies": { | ||
"@types/node": "16.3.2", | ||
"@types/node": "16.3.3", | ||
"braintree-jsdoc-template": "3.3.0", | ||
"eslint": "7.30.0", | ||
"eslint": "7.31.0", | ||
"eslint-config-nodemailer": "1.2.0", | ||
@@ -34,0 +34,0 @@ "eslint-config-prettier": "8.3.0", |
@@ -15,4 +15,2 @@ # ImapFlow | ||
### Free, AGPL-licensed version | ||
First install the module from npm: | ||
@@ -30,30 +28,2 @@ | ||
### MIT version | ||
MIT-licensed version is available for [Postal Systems subscribers](https://postalsys.com/). | ||
First install the module from Postal Systems private registry: | ||
``` | ||
$ npm install @postalsys/imapflow | ||
``` | ||
next import the ImapFlow class into your script: | ||
```js | ||
const { ImapFlow } = require('@postalsys/imapflow'); | ||
``` | ||
If you have already built your application using the free version of ImapFlow and do not want to modify require statements in your code, you can install the MIT-licensed version as an alias for "imapflow". | ||
``` | ||
$ npm install imapflow@npm:@postalsys/imapflow | ||
``` | ||
This way you can keep using the old module name | ||
```js | ||
const { ImapFlow } = require('imapflow'); | ||
``` | ||
### Promises | ||
@@ -83,3 +53,5 @@ | ||
// fetch latest message source | ||
let message = await client.fetchOne('*', { source: true }); | ||
// client.mailbox includes information about currently selected mailbox | ||
// "exists" value is also the largest sequence number available in the mailbox | ||
let message = await client.fetchOne(client.mailbox.exists, { source: true }); | ||
console.log(message.source.toString()); | ||
@@ -108,2 +80,30 @@ | ||
### Using the MIT-licensed version | ||
MIT-licensed version is available for [Postal Systems subscribers](https://postalsys.com/). | ||
First install the module from Postal Systems private registry: | ||
``` | ||
$ npm install @postalsys/imapflow | ||
``` | ||
next import the ImapFlow class into your script: | ||
```js | ||
const { ImapFlow } = require('@postalsys/imapflow'); | ||
``` | ||
If you have already built your application using the free version of ImapFlow and do not want to modify require statements in your code, you can install the MIT-licensed version as an alias for "imapflow". | ||
``` | ||
$ npm install imapflow@npm:@postalsys/imapflow | ||
``` | ||
This way you can keep using the old module name | ||
```js | ||
const { ImapFlow } = require('imapflow'); | ||
``` | ||
## License | ||
@@ -110,0 +110,0 @@ |
520195