imapflow - npm Package Compare versions
Comparing version 1.0.8 to 1.0.9
| # CHANGELOG | ||
| - v1.0.9 - 2020-02-02 | ||
| - Yet another documentation change to get TypeScript typings more correct | ||
| - v1.0.8 - 2020-02-02 | ||
@@ -4,0 +8,0 @@ |
@@ -77,2 +77,3 @@ /// <reference types="node" /> | ||
| * | ||
| * @returns {Promise<void>} | ||
| * @throws Will throw an error if connection or authentication fails | ||
@@ -83,6 +84,7 @@ * @example | ||
| */ | ||
| connect(): void; | ||
| connect(): Promise<void>; | ||
| /** | ||
| * Graceful connection close by sending logout command to server. TCP connection is closed once command is finished. | ||
| * | ||
| * @return {Promise<void>} | ||
| * @example | ||
@@ -94,3 +96,3 @@ * let client = new ImapFlow({...}); | ||
| */ | ||
| logout(): void; | ||
| logout(): Promise<void>; | ||
| /** | ||
@@ -110,3 +112,3 @@ * Closes TCP connection without notifying the server. | ||
| * @param {String} [path] Optional mailbox path if you want to check quota for specific folder | ||
| * @returns {QuotaResponse|Boolean} Quota information or `false` if QUTOA extension is not supported or requested path does not exist | ||
| * @returns {Promise<QuotaResponse|Boolean>} Quota information or `false` if QUTOA extension is not supported or requested path does not exist | ||
| * | ||
@@ -117,7 +119,7 @@ * @example | ||
| */ | ||
| getQuota(path?: string): QuotaResponse | boolean; | ||
| getQuota(path?: string): Promise<QuotaResponse | Boolean>; | ||
| /** | ||
| * Lists available mailboxes as an Array | ||
| * | ||
| * @returns {ListResponse[]} An array of ListResponse objects | ||
| * @returns {Promise<ListResponse[]>} An array of ListResponse objects | ||
| * | ||
@@ -128,7 +130,7 @@ * @example | ||
| */ | ||
| list(): ListResponse[]; | ||
| list(): Promise<ListResponse[]>; | ||
| /** | ||
| * Lists available mailboxes as a tree structured object | ||
| * | ||
| * @returns {ListTreeResponse} Tree structured object | ||
| * @returns {Promise<ListTreeResponse>} Tree structured object | ||
| * | ||
@@ -139,7 +141,8 @@ * @example | ||
| */ | ||
| listTree(): ListTreeResponse; | ||
| listTree(): Promise<ListTreeResponse>; | ||
| /** | ||
| * Performs a no-op call against server | ||
| * @returns {Promise<void>} | ||
| */ | ||
| noop(): void; | ||
| noop(): Promise<void>; | ||
| /** | ||
@@ -149,3 +152,3 @@ * Creates a new mailbox folder and sets up subscription for the created mailbox. Throws on error. | ||
| * @param {string|array} path Full mailbox path. Unicode is allowed. If value is an array then it is joined using current delimiter symbols. Namespace prefix is added automatically if required. | ||
| * @returns {MailboxCreateResponse} Mailbox info | ||
| * @returns {Promise<MailboxCreateResponse>} Mailbox info | ||
| * @throws Will throw an error if mailbox can not be created | ||
@@ -158,3 +161,3 @@ * | ||
| */ | ||
| mailboxCreate(path: string | any[]): MailboxCreateResponse; | ||
| mailboxCreate(path: string | any[]): Promise<MailboxCreateResponse>; | ||
| /** | ||
@@ -165,3 +168,3 @@ * Renames a mailbox. Throws on error. | ||
| * @param {string|array} newPath New path for the mailbox | ||
| * @returns {MailboxRenameResponse} Mailbox info | ||
| * @returns {Promise<MailboxRenameResponse>} Mailbox info | ||
| * @throws Will throw an error if mailbox does not exist or can not be renamed | ||
@@ -174,3 +177,3 @@ * | ||
| */ | ||
| mailboxRename(path: string | any[], newPath: string | any[]): MailboxRenameResponse; | ||
| mailboxRename(path: string | any[], newPath: string | any[]): Promise<MailboxRenameResponse>; | ||
| /** | ||
@@ -180,3 +183,3 @@ * Deletes a mailbox. Throws on error. | ||
| * @param {string|array} path Path for the mailbox to delete. Unicode is allowed. If value is an array then it is joined using current delimiter symbols. Namespace prefix is added automatically if required. | ||
| * @returns {MailboxDeleteResponse} Mailbox info | ||
| * @returns {Promise<MailboxDeleteResponse>} Mailbox info | ||
| * @throws Will throw an error if mailbox does not exist or can not be deleted | ||
@@ -189,3 +192,3 @@ * | ||
| */ | ||
| mailboxDelete(path: string | any[]): MailboxDeleteResponse; | ||
| mailboxDelete(path: string | any[]): Promise<MailboxDeleteResponse>; | ||
| /** | ||
@@ -195,3 +198,3 @@ * Subscribes to a mailbox | ||
| * @param {string|array} path Path for the mailbox to subscribe to. Unicode is allowed. If value is an array then it is joined using current delimiter symbols. Namespace prefix is added automatically if required. | ||
| * @returns {Boolean} `true` if subscription operation succeeded, `false` otherwise | ||
| * @returns {Promise<Boolean>} `true` if subscription operation succeeded, `false` otherwise | ||
| * | ||
@@ -201,3 +204,3 @@ * @example | ||
| */ | ||
| mailboxSubscribe(path: string | any[]): boolean; | ||
| mailboxSubscribe(path: string | any[]): Promise<Boolean>; | ||
| /** | ||
@@ -207,3 +210,3 @@ * Unsubscribes from a mailbox | ||
| * @param {string|array} path **Path for the mailbox** to unsubscribe from. Unicode is allowed. If value is an array then it is joined using current delimiter symbols. Namespace prefix is added automatically if required. | ||
| * @returns {Boolean} `true` if unsubscription operation succeeded, `false` otherwise | ||
| * @returns {Promise<Boolean>} `true` if unsubscription operation succeeded, `false` otherwise | ||
| * | ||
@@ -213,3 +216,3 @@ * @example | ||
| */ | ||
| mailboxUnsubscribe(path: string | any[]): boolean; | ||
| mailboxUnsubscribe(path: string | any[]): Promise<Boolean>; | ||
| /** | ||
@@ -223,3 +226,3 @@ * Opens a mailbox to access messages. You can perform message operations only against an opened mailbox. | ||
| * @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 | ||
| * @returns {Promise<MailboxObject>} Mailbox info | ||
| * @throws Will throw an error if mailbox does not exist or can not be opened | ||
@@ -234,7 +237,7 @@ * | ||
| readOnly?: boolean; | ||
| }): MailboxObject; | ||
| }): Promise<MailboxObject>; | ||
| /** | ||
| * Closes a previously opened mailbox | ||
| * | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -245,3 +248,3 @@ * @example | ||
| */ | ||
| mailboxClose(): boolean; | ||
| mailboxClose(): Promise<Boolean>; | ||
| /** | ||
@@ -258,3 +261,3 @@ * Requests the status of the indicated mailbox. Only requested status values will be returned. | ||
| * @param {Boolean} query.highestModseq if `true` request last known modseq value | ||
| * @returns {StatusObject} status of the indicated mailbox | ||
| * @returns {Promise<StatusObject>} status of the indicated mailbox | ||
| * | ||
@@ -273,8 +276,9 @@ * @example | ||
| highestModseq: boolean; | ||
| }): StatusObject; | ||
| }): Promise<StatusObject>; | ||
| /** | ||
| * Starts listening for new or deleted messages from the currently opened mailbox. Only required if {@link ImapFlow#disableAutoIdle} is set to `true` | ||
| * otherwise IDLE is started by default on connection inactivity. | ||
| * otherwise IDLE is started by default on connection inactivity. NB! If `idle()` is called manually then it does not | ||
| * return until IDLE is finished which means you would have to call some other command out of scope. | ||
| * | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -286,3 +290,3 @@ * @example | ||
| */ | ||
| idle(): boolean; | ||
| idle(): Promise<Boolean>; | ||
| /** | ||
@@ -295,3 +299,3 @@ * Sets flags for a message or message range | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -305,3 +309,3 @@ * @example | ||
| uid?: boolean; | ||
| }): boolean; | ||
| }): Promise<Boolean>; | ||
| /** | ||
@@ -314,3 +318,3 @@ * Adds flags for a message or message range | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -324,3 +328,3 @@ * @example | ||
| uid?: boolean; | ||
| }): boolean; | ||
| }): Promise<Boolean>; | ||
| /** | ||
@@ -333,3 +337,3 @@ * Remove specific flags from a message or message range | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -343,3 +347,3 @@ * @example | ||
| uid?: boolean; | ||
| }): boolean; | ||
| }): Promise<Boolean>; | ||
| /** | ||
@@ -352,3 +356,3 @@ * Delete messages from currently opened mailbox. Method does not indicate info about deleted messages, | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {Boolean} Did the operation succeed or not | ||
| * @returns {Promise<Boolean>} Did the operation succeed or not | ||
| * | ||
@@ -362,3 +366,3 @@ * @example | ||
| uid?: boolean; | ||
| }): boolean; | ||
| }): Promise<Boolean>; | ||
| /** | ||
@@ -371,3 +375,3 @@ * Appends a new message to a mailbox | ||
| * @param {Date|string} [idate=now] internal date to be set for the message | ||
| * @returns {AppendResponseObject} info about uploaded message | ||
| * @returns {Promise<AppendResponseObject>} info about uploaded message | ||
| * | ||
@@ -377,3 +381,3 @@ * @example | ||
| */ | ||
| append(path: string, content: string | Buffer, flags?: string[], idate?: Date | string): AppendResponseObject; | ||
| append(path: string, content: string | Buffer, flags?: string[], idate?: Date | string): Promise<AppendResponseObject>; | ||
| /** | ||
@@ -386,3 +390,3 @@ * Copies messages from current mailbox to destination mailbox | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {CopyResponseObject} info about copies messages | ||
| * @returns {Promise<CopyResponseObject>} info about copies messages | ||
| * | ||
@@ -397,3 +401,3 @@ * @example | ||
| uid?: boolean; | ||
| }): CopyResponseObject; | ||
| }): Promise<CopyResponseObject>; | ||
| /** | ||
@@ -406,3 +410,3 @@ * Moves messages from current mailbox to destination mailbox | ||
| * @param {Boolean} [options.uid] If `true` then uses UID {@link SequenceString} instead of sequence numbers | ||
| * @returns {CopyResponseObject} info about moved messages | ||
| * @returns {Promise<CopyResponseObject>} info about moved messages | ||
| * | ||
@@ -417,3 +421,3 @@ * @example | ||
| uid?: boolean; | ||
| }): CopyResponseObject; | ||
| }): Promise<CopyResponseObject>; | ||
| /** | ||
@@ -425,3 +429,3 @@ * Search messages from currently opened mailbox | ||
| * @param {Boolean} [options.uid] If `true` then returns UID numbers instead of sequence numbers | ||
| * @returns {number[]} An array of sequence or UID numbers | ||
| * @returns {Promise<Number[]>} An array of sequence or UID numbers | ||
| * | ||
@@ -435,3 +439,3 @@ * @example | ||
| uid?: boolean; | ||
| }): number[]; | ||
| }): Promise<Number[]>; | ||
| /** | ||
@@ -443,5 +447,5 @@ * Fetch messages from currently opened mailbox | ||
| * @param {Object} [options] | ||
| * @param {Boolean} [options.uid] If `true` then uses UID numbers instead of sequence numbers for range | ||
| * @param {Boolean} [options.uid] If `true` then uses UID numbers instead of sequence numbers for `range` | ||
| * @param {BigInt} [options.changedSince] If set then only messages with a higher modseq value are returned. Ignored if server does not support `CONDSTORE` extension. | ||
| * @yields {FetchMessageObject} Message data object | ||
| * @yields {Promise<FetchMessageObject>} Message data object | ||
| * | ||
@@ -465,4 +469,4 @@ * @example | ||
| * @param {Object} [options] | ||
| * @param {Boolean} [options.uid] If `true` then uses UID number instead of sequence number for range | ||
| * @returns {FetchMessageObject} Message data object | ||
| * @param {Boolean} [options.uid] If `true` then uses UID number instead of sequence number for `seq` | ||
| * @returns {Promise<FetchMessageObject>} Message data object | ||
| * | ||
@@ -477,3 +481,3 @@ * @example | ||
| uid?: boolean; | ||
| }): FetchMessageObject; | ||
| }): Promise<FetchMessageObject>; | ||
| /** | ||
@@ -487,4 +491,4 @@ * Download either full rfc822 formated message or a specific bodystructure part as a Stream. | ||
| * @param {Object} [options] | ||
| * @param {Boolean} [options.uid] If `true` then uses UID number instead of sequence number for range | ||
| * @returns {DownloadObject} Download data object | ||
| * @param {Boolean} [options.uid] If `true` then uses UID number instead of sequence number for `range` | ||
| * @returns {Promise<DownloadObject>} Download data object | ||
| * | ||
@@ -499,3 +503,3 @@ * @example | ||
| uid?: boolean; | ||
| }): DownloadObject; | ||
| }): Promise<DownloadObject>; | ||
| /** | ||
@@ -510,3 +514,3 @@ * Opens a mailbox if not already open and returns a lock. Next call to `getMailboxLock()` is queued | ||
| * @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 {MailboxLockObject} Mailbox lock | ||
| * @returns {Promise<MailboxLockObject>} Mailbox lock | ||
| * @throws Will throw an error if mailbox does not exist or can not be opened | ||
@@ -525,3 +529,3 @@ * | ||
| readOnly?: boolean; | ||
| }): MailboxLockObject; | ||
| }): Promise<MailboxLockObject>; | ||
| } | ||
@@ -528,0 +532,0 @@ } |
| { | ||
| "name": "imapflow", | ||
| "version": "1.0.8", | ||
| "version": "1.0.9", | ||
| "description": "IMAP Client for Node", | ||
@@ -5,0 +5,0 @@ "main": "./lib/imap-flow.js", |
Sorry, the diff of this file is too big to display
New alerts
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
Fixed alerts
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
Improved metrics
- Total package byte prevSize
- increased by0.29%
446665
- Lines of code
- increased by0.08%
10577