vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-07 00:07:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add missing types for imap-simple 4.2

Browse Source 
Add type definitions for functions:
- addBox
- delBox
- getBoxes
- append

Fix parameter name for delFlags.
This commit is contained in:
Ilari Aarnio
2018-12-02 23:09:05 +02:00
parent efbcbdebaf
commit 8ac2b26cf8
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/imap-simple/index.d.ts
Vendored
+20 -3
View File
@@ -1,6 +1,7 @@
// Type definitions for imap-simple v3.1.0
// Type definitions for imap-simple v4.2.0
// Project: https://github.com/chadxz/imap-simple
// Definitions by: Jeffery Grajkowski <https://github.com/pushplay>
// Ilari Aarnio <https://github.com/iaarnio>
// Definitions: https://github.com/psnider/DefinitelyTyped/imap-simple
/// <reference types="node" />
@@ -42,6 +43,18 @@ export class ImapSimple extends NodeJS.EventEmitter {
openBox(boxName: string, callback: (err: Error, boxName: string) => void): void;
openBox(boxName: string): Promise<string>;
/** Create a mailbox, calling the provided callback with signature (err, boxName), or resolves the returned promise with boxName. */
addBox(boxName: string, callback: (err: Error, boxName: string) => void): void;
addBox(boxName: string): Promise<string>;
/** Delete a mailbox, calling the provided callback with signature (err, boxName), or resolves the returned promise with boxName. */
delBox(boxName: string, callback: (err: Error, boxName: string) => void): void;
delBox(boxName: string): Promise<string>;
/** Returns the full list of mailboxes (folders). Upon success, either the provided callback will be called with signature (err, boxes), or the returned promise will be resolved with boxes. Boxes is the exact object returned from the node-imap getBoxes() result. */
getBoxes(callback: (err: Error, boxes: any) => void): void;
getBoxes(): Promise<any>;
/** Search for and retrieve mail in the previously opened mailbox. */
search(searchCriteria: any[], fetchOptions: Imap.FetchOptions, callback: (err: Error, messages: Message[]) => void): void;
search(searchCriteria: any[], fetchOptions: Imap.FetchOptions): Promise<Message[]>;
@@ -57,6 +70,10 @@ export class ImapSimple extends NodeJS.EventEmitter {
addMessageLabel(source: string | string[], label: string | string[], callback: (err: Error) => void): void;
addMessageLabel(source: string | string[], label: string | string[]): Promise<void>;
/** Appends the argument message to the currently open mailbox or another mailbox. Message is a RFC-822 compatible MIME message. Valid options are mailbox, flags and date. When completed, either calls the provided callback with signature (err), or resolves the returned promise. */
append(message: any, options: any, callback: (err: Error) => void): void;
append(message: any, options: any): Promise<void>;
/** Moves the specified message(s) in the currently open mailbox to another mailbox. source corresponds to a node-imap MessageSource which specifies the messages to be moved. When completed, either calls the provided callback with signature (err), or resolves the returned promise. */
moveMessage(source: string | string[], boxName: string, callback: (err: Error) => void): void;
moveMessage(source: string | string[], boxName: string): Promise<void>;
@@ -66,8 +83,8 @@ export class ImapSimple extends NodeJS.EventEmitter {
addFlags(source: string | string[], flag: string | string[]): Promise<void>;
/** Removes the provided flag(s) from the specified message(s). uid is the uid of the message you want to remove the flag from or an array of uids. flag is either a string or array of strings indicating the flags to remove. */
delFlags(source: string | string[], flag: string | string[], callback: (err: Error) => void): void;
delFlags(source: string | string[], flag: string | string[]): Promise<void>;
delFlags(uid: string | string[], flag: string | string[], callback: (err: Error) => void): void;
delFlags(uid: string | string[], flag: string | string[]): Promise<void>;
}
export namespace errors {