Comparing version 1.0.4 to 1.0.5
# CHANGELOG | ||
- v1.0.5 - 2020-01-29 | ||
- Updated TypeScript typings | ||
- v1.0.3 - 2020-01-28 | ||
@@ -4,0 +8,0 @@ |
@@ -0,1 +1,3 @@ | ||
/// <reference types="node" /> | ||
/** | ||
@@ -5,16 +7,18 @@ * @module imapflow | ||
declare module "imapflow" { | ||
import { EventEmitter } from "events"; | ||
/** | ||
* @typedef {Object} MailboxObject | ||
* @property {string} path mailbox path | ||
* @property {string} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {String} path mailbox path | ||
* @property {String} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {Set<string>} flags list of flags for this mailbox | ||
* @property {string} [specialUse] one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
* @property {String} [specialUse] one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {Boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {Boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
* @property {Set<string>} permanentFlags A Set of flags available to use in this mailbox. If it is not set or includes special flag "\\\*" then any flag can be used. | ||
* @property {string} [mailboxId] unique mailbox ID if server has OBJECTID extension enabled | ||
* @property {String} [mailboxId] unique mailbox ID if server has OBJECTID extension enabled | ||
* @property {BigInt} [highestModseq] latest known modseq value if server has CONDSTORE or XYMHIGHESTMODSEQ enabled | ||
* @property {BigInt} uidValidity Mailbox UIDVALIDITY value | ||
* @property {number} uidNext Next predicted UID | ||
* @property {number} exists Messages in this folder | ||
* @property {Number} uidNext Next predicted UID | ||
* @property {Number} exists Messages in this folder | ||
*/ | ||
@@ -38,7 +42,7 @@ type MailboxObject = { | ||
* @typedef {Object} IdInfoObject | ||
* @property {string} [name] Name of the program | ||
* @property {string} [version] Version number of the program | ||
* @property {string} [os] Name of the operating system | ||
* @property {string} [vendor] Vendor of the client/server | ||
* @property {string} ['support-url'] URL to contact for support | ||
* @property {String} [name] Name of the program | ||
* @property {String} [version] Version number of the program | ||
* @property {String} [os] Name of the operating system | ||
* @property {String} [vendor] Vendor of the client/server | ||
* @property {String} ['support-url'] URL to contact for support | ||
*/ | ||
@@ -56,15 +60,15 @@ type IdInfoObject = { | ||
* @param {Number} options.port Port number for the IMAP server | ||
* @param {String} [options.secure=false] Should the connection be established over TLS. | ||
* @param {Boolean} [options.secure=false] Should the connection be established over TLS. | ||
* If *false* then connection is upgraded to TLS using STARTTLS extension before authentication | ||
* @param {string} [options.servername] Servername for SNI (or when host is set to an IP address) | ||
* @param {boolean} [options.disableCompression=false] if *true* then client does not try to use COMPRESS=DEFLATE extension | ||
* @param {object} options.auth Authentication options. Authentication is requested automatically during <code>connect()</code> | ||
* @param {object} options.auth.user Usename | ||
* @param {object} options.auth.pass Password | ||
* @param {String} [options.servername] Servername for SNI (or when host is set to an IP address) | ||
* @param {Boolean} [options.disableCompression=false] if *true* then client does not try to use COMPRESS=DEFLATE extension | ||
* @param {Object} options.auth Authentication options. Authentication is requested automatically during <code>connect()</code> | ||
* @param {Object} options.auth.user Usename | ||
* @param {Object} options.auth.pass Password | ||
* @param {IdInfoObject} [options.clientInfo] Client identification info ({@link IdInfoObject}) | ||
* @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 {boolean} [options.tls.rejectUnauthorized=true] if *false* then client accepts self-signed and expired certificates from the server | ||
* @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 {object} [options.logger] Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format | ||
* @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 | ||
* @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 {Object} [options.logger] Custom logger instance with `debug(obj)`, `info(obj)`, `warn(obj)` and `error(obj)` methods. If not provided then ImapFlow logs to console using pino format | ||
*/ | ||
@@ -75,3 +79,3 @@ class ImapFlow extends EventEmitter { | ||
port: number; | ||
secure?: string; | ||
secure?: boolean; | ||
servername?: string; | ||
@@ -146,3 +150,3 @@ disableCompression?: boolean; | ||
* | ||
* @param {string} [path] Optional mailbox path if you want to check quota for specific folder | ||
* @param {String} [path] Optional mailbox path if you want to check quota for specific folder | ||
* @returns {Boolean|QuotaResponse} Quota information or *false* if QUTOA extension is not supported | ||
@@ -240,4 +244,4 @@ * | ||
* @param {string|array} path **Path for the mailbox** to open | ||
* @param {object} [options] optional options | ||
* @param {boolean} [options.readOnly=false] If *true* then opens mailbox in read-only mode. You can still try to perform write operations but these would probably fail. | ||
* @param {Object} [options] optional options | ||
* @param {Boolean} [options.readOnly=false] If *true* then opens mailbox in read-only mode. You can still try to perform write operations but these would probably fail. | ||
* @returns {MailboxObject} Mailbox info | ||
@@ -266,10 +270,10 @@ * | ||
* | ||
* @param {string} path mailbox path to check for | ||
* @param {object} query defines requested status items | ||
* @param {boolean} query.messages if *true* request count of messages | ||
* @param {boolean} query.recent if *true* request count of messages with \\Recent tag | ||
* @param {boolean} query.uidNext if *true* request predicted next UID | ||
* @param {boolean} query.uidValidity if *true* request mailbox UIDVALIDITY value | ||
* @param {boolean} query.unseen if *true* request count of unseen messages | ||
* @param {boolean} query.highestModseq if *true* request last known modseq value | ||
* @param {String} path mailbox path to check for | ||
* @param {Object} query defines requested status items | ||
* @param {Boolean} query.messages if *true* request count of messages | ||
* @param {Boolean} query.recent if *true* request count of messages with \\Recent tag | ||
* @param {Boolean} query.uidNext if *true* request predicted next UID | ||
* @param {Boolean} query.uidValidity if *true* request mailbox UIDVALIDITY value | ||
* @param {Boolean} query.unseen if *true* request count of unseen messages | ||
* @param {Boolean} query.highestModseq if *true* request last known modseq value | ||
* @returns {StatusObject} status of the indicated mailbox | ||
@@ -307,4 +311,4 @@ * | ||
* @param {string[]} Array of flags to set. Only flags that are permitted to set are used, other flags are ignored | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {Boolean} Did the operation succeed or not | ||
@@ -325,4 +329,4 @@ * | ||
* @param {string[]} Array of flags to set. Only flags that are permitted to set are used, other flags are ignored | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {Boolean} Did the operation succeed or not | ||
@@ -343,4 +347,4 @@ * | ||
* @param {string[]} Array of flags to remove. Only flags that are permitted to set are used, other flags are ignored | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {Boolean} Did the operation succeed or not | ||
@@ -361,4 +365,4 @@ * | ||
* @param {SequenceString | SearchObject} range Range to filter the messages | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {Boolean} Did the operation succeed or not | ||
@@ -377,3 +381,3 @@ * | ||
* | ||
* @param {string} path Mailbox path to upload the message to | ||
* @param {String} path Mailbox path to upload the message to | ||
* @param {string|Buffer} content RFC822 formatted email message | ||
@@ -392,5 +396,5 @@ * @param {string[]} [flags] an array of flags to be set for the uploaded message | ||
* @param {SequenceString | SearchObject} range Range of messages to copy | ||
* @param {string} destination Mailbox path to copy the messages to | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {String} destination Mailbox path to copy the messages to | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {CopyResponseObject} info about copies messages | ||
@@ -411,5 +415,5 @@ * | ||
* @param {SequenceString | SearchObject} range Range of messages to move | ||
* @param {string} destination Mailbox path to move the messages to | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @param {String} destination Mailbox path to move the messages to | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID {@link SequenceString} instead of sequence numbers | ||
* @returns {CopyResponseObject} info about moved messages | ||
@@ -430,4 +434,4 @@ * | ||
* @param {SearchObject} query Query to filter the messages | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then returns UID numbers instead of sequence numbers | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then returns UID numbers instead of sequence numbers | ||
* @returns {number[]} An array of sequence or UID numbers | ||
@@ -448,4 +452,4 @@ * | ||
* @param {FetchQueryObject} query Fetch query | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID numbers instead of sequence numbers for range | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID numbers instead of sequence numbers for range | ||
* @yields {FetchMessageObject} Message data object | ||
@@ -468,4 +472,4 @@ * | ||
* @param {FetchQueryObject} query Fetch query | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID number instead of sequence number for range | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID number instead of sequence number for range | ||
* @returns {FetchMessageObject} Message data object | ||
@@ -488,5 +492,5 @@ * | ||
* @param {SequenceString} range UID or sequence number for the message to fetch | ||
* @param {string} [part] If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part | ||
* @param {object} [options] | ||
* @param {boolean} [options.uid] If *true* then uses UID number instead of sequence number for range | ||
* @param {String} [part] If not set then downloads entire rfc822 formatted message, otherwise downloads specific bodystructure part | ||
* @param {Object} [options] | ||
* @param {Boolean} [options.uid] If *true* then uses UID number instead of sequence number for range | ||
* @returns {DownloadObject} Download data object | ||
@@ -506,9 +510,9 @@ * | ||
* @typedef {Object} QuotaResponse | ||
* @property {string} path=INBOX mailbox path this quota applies to | ||
* @property {String} path=INBOX mailbox path this quota applies to | ||
* @property {Object} [storage] Storage quota if provided by server | ||
* @property {number} [storage.used] used storage in bytes | ||
* @property {number} [storage.limit] total storage available | ||
* @property {Number} [storage.used] used storage in bytes | ||
* @property {Number} [storage.limit] total storage available | ||
* @property {Object} [messages] Message count quota if provided by server | ||
* @property {number} [messages.used] stored messages | ||
* @property {number} [messages.limit] maximum messages allowed | ||
* @property {Number} [messages.used] stored messages | ||
* @property {Number} [messages.limit] maximum messages allowed | ||
*/ | ||
@@ -528,9 +532,9 @@ type QuotaResponse = { | ||
* @typedef {Object} ListResponse | ||
* @property {string} path mailbox path | ||
* @property {string} name mailbox name (last part of path after delimiter) | ||
* @property {string} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {String} path mailbox path | ||
* @property {String} name mailbox name (last part of path after delimiter) | ||
* @property {String} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {Set<string>} flags a set of flags for this mailbox | ||
* @property {string} specialUse one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
* @property {String} specialUse one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {Boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {Boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
*/ | ||
@@ -548,11 +552,11 @@ type ListResponse = { | ||
* @typedef {Object} ListTreeResponse | ||
* @property {boolean} root If *true* then this is root node without any additional properties besides *folders* | ||
* @property {string} path mailbox path | ||
* @property {string} name mailbox name (last part of path after delimiter) | ||
* @property {string} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {Boolean} root If *true* then this is root node without any additional properties besides *folders* | ||
* @property {String} path mailbox path | ||
* @property {String} name mailbox name (last part of path after delimiter) | ||
* @property {String} delimiter mailbox path delimiter, usually "." or "/" | ||
* @property {array} flags list of flags for this mailbox | ||
* @property {string} specialUse one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
* @property {boolean} disabled If *true* then this mailbox can not be selected in the UI | ||
* @property {String} specialUse one of special-use flags (if applicable): "\All", "\Archive", "\Drafts", "\Flagged", "\Junk", "\Sent", "\Trash". Additionally INBOX has non-standard "\Inbox" flag set | ||
* @property {Boolean} listed *true* if mailbox was found from the output of LIST command | ||
* @property {Boolean} subscribed *true* if mailbox was found from the output of LSUB command | ||
* @property {Boolean} disabled If *true* then this mailbox can not be selected in the UI | ||
* @property {ListTreeResponse[]} folders An array of subfolders | ||
@@ -574,4 +578,4 @@ */ | ||
* @typedef {Object} MailboxCreateResponse | ||
* @property {string} path full mailbox path | ||
* @property {string} [mailboxId] unique mailbox ID if server supports OBJECTID extension (currently Yahoo and some others) | ||
* @property {String} path full mailbox path | ||
* @property {String} [mailboxId] unique mailbox ID if server supports OBJECTID extension (currently Yahoo and some others) | ||
*/ | ||
@@ -584,4 +588,4 @@ type MailboxCreateResponse = { | ||
* @typedef {Object} MailboxRenameResponse | ||
* @property {string} path full mailbox path that was renamed | ||
* @property {string} newPath new full mailbox path | ||
* @property {String} path full mailbox path that was renamed | ||
* @property {String} newPath new full mailbox path | ||
*/ | ||
@@ -594,3 +598,3 @@ type MailboxRenameResponse = { | ||
* @typedef {Object} MailboxDeleteResponse | ||
* @property {string} path full mailbox path that was deleted | ||
* @property {String} path full mailbox path that was deleted | ||
*/ | ||
@@ -602,8 +606,8 @@ type MailboxDeleteResponse = { | ||
* @typedef {Object} StatusObject | ||
* @property {string} path full mailbox path that was checked | ||
* @property {number} [messages] Count of messages | ||
* @property {number} [recent] Count of messages with \\Recent tag | ||
* @property {number} [uidNext] Predicted next UID | ||
* @property {String} path full mailbox path that was checked | ||
* @property {Number} [messages] Count of messages | ||
* @property {Number} [recent] Count of messages with \\Recent tag | ||
* @property {Number} [uidNext] Predicted next UID | ||
* @property {BigInt} [uidValidity] Mailbox UIDVALIDITY value | ||
* @property {number} [unseen] Count of unseen messages | ||
* @property {Number} [unseen] Count of unseen messages | ||
* @property {BigInt} [highestModseq] Last known modseq value (if CONDSTORE extension is enabled) | ||
@@ -634,23 +638,23 @@ */ | ||
* @property {SequenceString} [seq] message ordering sequence range | ||
* @property {boolean} [answered] Messages with (value is *true*) or without (value is *false*) \\Answered flag | ||
* @property {boolean} [deleted] Messages with (value is *true*) or without (value is *false*) \\Deleted flag | ||
* @property {boolean} [draft] Messages with (value is *true*) or without (value is *false*) \\Draft flag | ||
* @property {boolean} [flagged] Messages with (value is *true*) or without (value is *false*) \\Flagged flag | ||
* @property {boolean} [seen] Messages with (value is *true*) or without (value is *false*) \\Seen flag | ||
* @property {boolean} [all] If *true* matches all messages | ||
* @property {boolean} [new] If *true* matches messages that have the \\Recent flag set but not the \\Seen flag | ||
* @property {boolean} [old] If *true* matches messages that do not have the \\Recent flag set | ||
* @property {boolean} [recent] If *true* matches messages that have the \\Recent flag set | ||
* @property {string} [from] Matches From: address field | ||
* @property {string} [to] Matches To: address field | ||
* @property {string} [cc] Matches Cc: address field | ||
* @property {string} [bcc] Matches Bcc: address field | ||
* @property {string} [body] Matches message body | ||
* @property {string} [subject] Matches message subject | ||
* @property {number} [larger] Matches messages larger than value | ||
* @property {number} [smaller] Matches messages smaller than value | ||
* @property {Boolean} [answered] Messages with (value is *true*) or without (value is *false*) \\Answered flag | ||
* @property {Boolean} [deleted] Messages with (value is *true*) or without (value is *false*) \\Deleted flag | ||
* @property {Boolean} [draft] Messages with (value is *true*) or without (value is *false*) \\Draft flag | ||
* @property {Boolean} [flagged] Messages with (value is *true*) or without (value is *false*) \\Flagged flag | ||
* @property {Boolean} [seen] Messages with (value is *true*) or without (value is *false*) \\Seen flag | ||
* @property {Boolean} [all] If *true* matches all messages | ||
* @property {Boolean} [new] If *true* matches messages that have the \\Recent flag set but not the \\Seen flag | ||
* @property {Boolean} [old] If *true* matches messages that do not have the \\Recent flag set | ||
* @property {Boolean} [recent] If *true* matches messages that have the \\Recent flag set | ||
* @property {String} [from] Matches From: address field | ||
* @property {String} [to] Matches To: address field | ||
* @property {String} [cc] Matches Cc: address field | ||
* @property {String} [bcc] Matches Bcc: address field | ||
* @property {String} [body] Matches message body | ||
* @property {String} [subject] Matches message subject | ||
* @property {Number} [larger] Matches messages larger than value | ||
* @property {Number} [smaller] Matches messages smaller than value | ||
* @property {SequenceString} [uid] UID sequence range | ||
* @property {BigInt} [modseq] Matches messages with modseq higher than value | ||
* @property {string} [emailId] unique email ID. Only used if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {string} [threadId] unique thread ID. Only used if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {String} [emailId] unique email ID. Only used if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {String} [threadId] unique thread ID. Only used if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {Date|string} [before] Matches messages received before date | ||
@@ -662,4 +666,4 @@ * @property {Date|string} [on] Matches messages received on date (ignores time) | ||
* @property {Date|string} [sentSince] Matches messages sent after date | ||
* @property {string} [keyword] Matches messages that have the custom flag set | ||
* @property {string} [unKeyword] Matches messages that do not have the custom flag set | ||
* @property {String} [keyword] Matches messages that have the custom flag set | ||
* @property {String} [unKeyword] Matches messages that do not have the custom flag set | ||
* @property {Object.<string, Boolean|String>} [header] Mathces messages with header key set (if value is *true*) or messages where header partially matches (if value is a string) | ||
@@ -706,6 +710,6 @@ * @property {SearchObject[]} [or] An array of 2 or more {@link SearchObject} objects. At least on of these must match | ||
* @typedef {Object} AppendResponseObject | ||
* @property {string} path full mailbox path where the message was uploaded to | ||
* @property {String} path full mailbox path where the message was uploaded to | ||
* @property {BigInt} [uidValidity] mailbox UIDVALIDITY if server has UIDPLUS extension enabled | ||
* @property {number} [uid] UID of the uploaded message if server has UIDPLUS extension enabled | ||
* @property {number} [seq] sequence number of the uploaded message if path is currently selected mailbox | ||
* @property {Number} [uid] UID of the uploaded message if server has UIDPLUS extension enabled | ||
* @property {Number} [seq] sequence number of the uploaded message if path is currently selected mailbox | ||
*/ | ||
@@ -720,4 +724,4 @@ type AppendResponseObject = { | ||
* @typedef {Object} CopyResponseObject | ||
* @property {string} path path of source mailbox | ||
* @property {string} destination path of destination mailbox | ||
* @property {String} path path of source mailbox | ||
* @property {String} destination path of destination mailbox | ||
* @property {BigInt} [uidValidity] destination mailbox UIDVALIDITY if server has UIDPLUS extension enabled | ||
@@ -734,13 +738,13 @@ * @property {Map<number, number>} [uidMap] Map of UID values (if server has UIDPLUS extension enabled) where key is UID in source mailbox and value is the UID for the same message in destination mailbox | ||
* @typedef {Object} FetchQueryObject | ||
* @property {boolean} [uid] if *true* then include UID in the response | ||
* @property {boolean} [flags] if *true* then include flags Set in the response | ||
* @property {boolean} [bodyStructure] if *true* then include parsed BODYSTRUCTURE object in the response | ||
* @property {boolean} [envelope] if *true* then include parsed ENVELOPE object in the response | ||
* @property {boolean} [internalDate] if *true* then include internal date value in the response | ||
* @property {boolean} [size] if *true* then include message size in the response | ||
* @property {Boolean} [uid] if *true* then include UID in the response | ||
* @property {Boolean} [flags] if *true* then include flags Set in the response | ||
* @property {Boolean} [bodyStructure] if *true* then include parsed BODYSTRUCTURE object in the response | ||
* @property {Boolean} [envelope] if *true* then include parsed ENVELOPE object in the response | ||
* @property {Boolean} [internalDate] if *true* then include internal date value in the response | ||
* @property {Boolean} [size] if *true* then include message size in the response | ||
* @property {boolean | Object} [source] if *true* then include full message in the response | ||
* @property {number} [source.start] include full message in the response starting from *start* byte | ||
* @property {number} [source.maxLength] include full message in the response, up to *maxLength* bytes | ||
* @property {string} [threadId] if *true* then include thread ID in the response (only if server supports either OBJECTID or X-GM-EXT-1 extensions) | ||
* @property {boolean} [labels] if *true* then include GMail labels in the response (only if server supports X-GM-EXT-1 extension) | ||
* @property {Number} [source.start] include full message in the response starting from *start* byte | ||
* @property {Number} [source.maxLength] include full message in the response, up to *maxLength* bytes | ||
* @property {String} [threadId] if *true* then include thread ID in the response (only if server supports either OBJECTID or X-GM-EXT-1 extensions) | ||
* @property {Boolean} [labels] if *true* then include GMail labels in the response (only if server supports X-GM-EXT-1 extension) | ||
* @property {boolean | string[]} [headers] if *true* then includes full headers of the message in the response. If the value is an array of header keys then includes only headers listed in the array | ||
@@ -769,4 +773,4 @@ * @property {string[]} [bodyParts] An array of BODYPART identifiers to include in the response | ||
* @typedef {Object} MessageAddressObject | ||
* @property {string} [name] name of the address object (unicode) | ||
* @property {string} [address] email address | ||
* @property {String} [name] name of the address object (unicode) | ||
* @property {String} [address] email address | ||
*/ | ||
@@ -782,5 +786,5 @@ type MessageAddressObject = { | ||
* @property {Date} [date] header date | ||
* @property {string} [subject] message subject (unicode) | ||
* @property {string} [messageId] Message ID of the message | ||
* @property {string} [inReplyTo] Message ID from In-Reply-To header | ||
* @property {String} [subject] message subject (unicode) | ||
* @property {String} [messageId] Message ID of the message | ||
* @property {String} [inReplyTo] Message ID from In-Reply-To header | ||
* @property {MessageAddressObject[]} [from] Array of addresses from the From: header | ||
@@ -809,11 +813,11 @@ * @property {MessageAddressObject[]} [sender] Array of addresses from the Sender: header | ||
* @typedef {Object} MessageStructureObject | ||
* @property {string} part Body part number. This value can be used to later fetch the contents of this part of the message | ||
* @property {string} type Content-Type of this node | ||
* @property {object} [parameters] Additional parameters for Content-Type, eg "charset" | ||
* @property {string} [id] Content-ID | ||
* @property {string} [encoding] Transfer encoding | ||
* @property {number} [size] Expected size of the node | ||
* @property {String} part Body part number. This value can be used to later fetch the contents of this part of the message | ||
* @property {String} type Content-Type of this node | ||
* @property {Object} [parameters] Additional parameters for Content-Type, eg "charset" | ||
* @property {String} [id] Content-ID | ||
* @property {String} [encoding] Transfer encoding | ||
* @property {Number} [size] Expected size of the node | ||
* @property {MessageEnvelopeObject} [envelope] message envelope of embedded RFC822 message | ||
* @property {string} [disposition] Content disposition | ||
* @property {object} [dispositionParameters] Additional parameters for Conent-Disposition | ||
* @property {String} [disposition] Content disposition | ||
* @property {Object} [dispositionParameters] Additional parameters for Conent-Disposition | ||
* @property {MessageStructureObject[]} childNodes An array of child nodes if this is a multipart node. Not present for normal nodes | ||
@@ -837,10 +841,10 @@ */ | ||
* @typedef {Object} FetchMessageObject | ||
* @property {number} seq message sequence number. Always included in the response | ||
* @property {number} uid message UID number. Always included in the response | ||
* @property {Number} seq message sequence number. Always included in the response | ||
* @property {Number} uid message UID number. Always included in the response | ||
* @property {Buffer} [source] message source for the requested byte range | ||
* @property {BigInt} [modseq] message Modseq number. Always included if the server supports CONDSTORE extension | ||
* @property {string} [emailId] unique email ID. Always included if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {string} [threadid] unique thread ID. Only present if server supports OBJECTID or X-GM-EXT-1 extension | ||
* @property {String} [emailId] unique email ID. Always included if server supports OBJECTID or X-GM-EXT-1 extensions | ||
* @property {String} [threadid] unique thread ID. Only present if server supports OBJECTID or X-GM-EXT-1 extension | ||
* @property {Set<string>} [labels] a Set of labels. Only present if server supports X-GM-EXT-1 extension | ||
* @property {number} [size] message size | ||
* @property {Number} [size] message size | ||
* @property {Set<string>} [flags] a set of message flags | ||
@@ -872,6 +876,6 @@ * @property {MessageEnvelopeObject} [envelope] message envelope | ||
* @property {Object} meta content metadata | ||
* @property {string} meta.contentType Content-Type of the streamed file. If part was not set then this value is "message/rfc822" | ||
* @property {string} [meta.charset] Charset of the body part. Text parts are automaticaly converted to UTF-8, attachments are kept as is | ||
* @property {string} [meta.disposition] Content-Disposition of the streamed file | ||
* @property {string} [meta.filename] Filename of the streamed body part | ||
* @property {String} meta.contentType Content-Type of the streamed file. If part was not set then this value is "message/rfc822" | ||
* @property {String} [meta.charset] Charset of the body part. Text parts are automaticaly converted to UTF-8, attachments are kept as is | ||
* @property {String} [meta.disposition] Content-Disposition of the streamed file | ||
* @property {String} [meta.filename] Filename of the streamed body part | ||
* @property {ReadableStream} content Streamed content | ||
@@ -878,0 +882,0 @@ */ |
{ | ||
"name": "imapflow", | ||
"version": "1.0.4", | ||
"version": "1.0.5", | ||
"description": "IMAP Client for Node", | ||
@@ -11,3 +11,3 @@ "main": "./lib/imap-flow.js", | ||
"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/", | ||
"dst": "node types.js", | ||
"build": "npm run docs && npm run dst" | ||
@@ -43,2 +43,3 @@ }, | ||
"dependencies": { | ||
"@types/node": "13.5.1", | ||
"encoding-japanese": "1.0.30", | ||
@@ -45,0 +46,0 @@ "iconv-lite": "0.5.1", |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
434122
56
10284
9
1
3
+ Added@types/node@13.5.1
+ Added@types/node@13.5.1(transitive)