Update definition for "maildev".

This commit is contained in:
Cyril Schumacher
2015-08-14 19:33:40 +02:00
parent 18bd87062f
commit e51aa4f321
2 changed files with 36 additions and 16 deletions
+3 -2
View File
@@ -5,8 +5,9 @@ import MailDev = require("maildev")
var options: MailDevOptions = {smtp: 1025};
var maildev = new MailDev(options);
var errorCallback = (error: Error) => {};
var errorCallback = (error: Error): void => {};
maildev.listen(errorCallback);
var eventName = 'new';
maildev.on(eventName, errorCallback)
var emailCallback = (email: Object): void => {};
maildev.on(eventName, emailCallback)
+33 -14
View File
@@ -49,15 +49,15 @@ interface MailDevOptions {
* Interface for mail.
*/
interface Mail {
/**
* Identifier.
*/
id?: string;
/**
* Identifier.
*/
id?: string;
/**
* Client.
*/
envelope?: Object;
/**
* Client.
*/
envelope?: Object;
}
declare module "maildev" {
@@ -75,11 +75,28 @@ declare module "maildev" {
*/
constructor(options: MailDevOptions);
/**
* Deletes a given email by identifier.
*
* @public
* @param {string} id The email identifier.
* @param {Function} callback The error callback.
*/
deleteEmail(id: string, callback?: (error: Error) => void): void;
/**
* Deletes all email and their attachments.
*
* @public
* @param {Function} callback The error callback.
*/
deleteAllEmail(callback?: (error: Error) => void): void;
/**
* Stops the SMTP server.
*
* @public
* @param callback The error callback.
* @param {Function} callback The error callback.
*/
end(callback?: (error: Error) => void): void;
@@ -87,7 +104,8 @@ declare module "maildev" {
* Accepts e-mail identifier, returns email object.
*
* @public
* @param {string} id The e-mail identifier.
* @param {string} id The e-mail identifier.
* @param {Function} callback The error callback.
*/
getEmail(id: string, callback?: (error: Error) => void): void;
@@ -110,7 +128,7 @@ declare module "maildev" {
* Starts the SMTP server.
*
* @public
* @param callback The error callback.
* @param {Function} callback The error callback.
*/
listen(callback?: (error: Error) => void): void;
@@ -118,15 +136,16 @@ declare module "maildev" {
* Event called when a new e-mail is received. Callback receives single mail object.
*
* @public
* @param {string} eventName The event name.
* @param callback The callback for obtains the received email.
* @param {string} eventName The event name.
* @param {Function} email The email.
*/
on(eventName: string, callback: (email: string) => void): void;
on(eventName: string, callback: (email: Object) => void): void;
/**
* Relay the e-mail.
*
* @param {string} idOrMailObject The identifier or mail object.
* @param {Function} done The callback.
*/
relayMail(idOrMailObject: string, done: (error: Error) => void): void;
}