@types/nodemailer 6.4.1 → 6.4.2

nodemailer/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Nodemailer (https://github.com/nodema
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nodemailer.
 
 ### Additional Details
- * Last updated: Fri, 12 Mar 2021 19:14:06 GMT
+ * Last updated: Mon, 24 May 2021 12:32:37 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 

nodemailer/index.d.ts

@@ -19,17 +19,17 @@ import StreamTransport = require('./lib/stream-transport');
 
 export type SendMailOptions = Mail.Options;
 
-export type SentMessageInfo = any;
+export type Transporter<T = any> = Mail<T>;
 
-export type Transporter = Mail;
+export type SentMessageInfo = any;
 
-export interface Transport {
-    mailer?: Transporter;
+export interface Transport<T = any> {
+    mailer?: Transporter<T>;
 
     name: string;
     version: string;
 
-    send(mail: MailMessage, callback: (err: Error | null, info: SentMessageInfo) => void): void;
+    send(mail: MailMessage<T>, callback: (err: Error | null, info: T) => void): void;
 
     verify?(callback: (err: Error | null, success: true) => void): void;
     verify?(): Promise<true>;
@@ -53,25 +53,25 @@ export interface TestAccount {
 export function createTransport(
     transport?: SMTPTransport | SMTPTransport.Options | string,
     defaults?: SMTPTransport.Options,
-): Transporter;
-export function createTransport(transport: SMTPPool | SMTPPool.Options, defaults?: SMTPPool.Options): Transporter;
+): Transporter<SMTPTransport.SentMessageInfo>;
+export function createTransport(transport: SMTPPool | SMTPPool.Options, defaults?: SMTPPool.Options): Transporter<SMTPPool.SentMessageInfo>;
 export function createTransport(
     transport: SendmailTransport | SendmailTransport.Options,
     defaults?: SendmailTransport.Options,
-): Transporter;
+): Transporter<SendmailTransport.SentMessageInfo>;
 export function createTransport(
     transport: StreamTransport | StreamTransport.Options,
     defaults?: StreamTransport.Options,
-): Transporter;
+): Transporter<StreamTransport.SentMessageInfo>;
 export function createTransport(
     transport: JSONTransport | JSONTransport.Options,
     defaults?: JSONTransport.Options,
-): Transporter;
+): Transporter<JSONTransport.SentMessageInfo>;
 export function createTransport(
     transport: SESTransport | SESTransport.Options,
     defaults?: SESTransport.Options,
-): Transporter;
-export function createTransport(transport: Transport | TransportOptions, defaults?: TransportOptions): Transporter;
+): Transporter<SESTransport.SentMessageInfo>;
+export function createTransport<T>(transport: Transport<T> | TransportOptions, defaults?: TransportOptions): Transporter<T>;
 
 export function createTestAccount(
     apiUrl: string,

nodemailer/lib/json-transport.d.ts

@@ -28,11 +28,11 @@ declare namespace JSONTransport {
     }
 }
 
-declare class JSONTransport implements Transport {
+declare class JSONTransport implements Transport<JSONTransport.SentMessageInfo> {
     options: JSONTransport.Options;
 
     logger: shared.Logger;
-    mailer: Mail;
+    mailer: Mail<JSONTransport.SentMessageInfo>;
 
     name: string;
     version: string;
@@ -40,7 +40,7 @@ declare class JSONTransport implements Transport {
     constructor(options: JSONTransport.Options);
 
     /** Compiles a mailcomposer message and forwards it to handler that sends it */
-    send(mail: MailMessage, callback: (err: Error | null, info: JSONTransport.SentMessageInfo) => void): void;
+    send(mail: MailMessage<JSONTransport.SentMessageInfo>, callback: (err: Error | null, info: JSONTransport.SentMessageInfo) => void): void;
 }
 
 export = JSONTransport;

nodemailer/lib/mailer/index.d.ts

@@ -5,7 +5,7 @@ import { Socket } from 'net';
 import { Readable } from 'stream';
 import { Url } from 'url';
 
-import { SentMessageInfo, Transport, TransportOptions } from '../..';
+import { Transport, TransportOptions } from '../..';
 import * as shared from '../shared';
 
 import DKIM = require('../dkim');
@@ -153,21 +153,21 @@ declare namespace Mail {
         priority?: "high"|"normal"|"low";
     }
 
-    type PluginFunction = (mail: MailMessage, callback: (err?: Error | null) => void) => void;
+    type PluginFunction<T = any> = (mail: MailMessage<T>, callback: (err?: Error | null) => void) => void;
 }
 
 /** Creates an object for exposing the Mail API */
-declare class Mail extends EventEmitter {
+declare class Mail<T = any> extends EventEmitter {
     options: Mail.Options;
     meta: Map<string, any>;
     dkim: DKIM;
-    transporter: Transport;
+    transporter: Transport<T>;
     logger: shared.Logger;
 
     /** Usage: typeof transporter.MailMessage */
-    MailMessage: MailMessage;
+    MailMessage: MailMessage<T>;
 
-    constructor(transporter: Transport, options?: TransportOptions, defaults?: TransportOptions);
+    constructor(transporter: Transport<T>, options?: TransportOptions, defaults?: TransportOptions);
 
     /** Closes all connections in the pool. If there is a message being sent, the connection is closed later */
     close(): void;
@@ -179,11 +179,11 @@ declare class Mail extends EventEmitter {
     verify(callback: (err: Error | null, success: true) => void): void;
     verify(): Promise<true>;
 
-    use(step: string, plugin: Mail.PluginFunction): this;
+    use(step: string, plugin: Mail.PluginFunction<T>): this;
 
     /** Sends an email using the preselected transport object */
-    sendMail(mailOptions: Mail.Options, callback: (err: Error | null, info: SentMessageInfo) => void): void;
-    sendMail(mailOptions: Mail.Options): Promise<SentMessageInfo>;
+    sendMail(mailOptions: Mail.Options, callback: (err: Error | null, info: T) => void): void;
+    sendMail(mailOptions: Mail.Options): Promise<T>;
 
     getVersionString(): string;
 

nodemailer/lib/mailer/mail-message.d.ts

@@ -5,12 +5,12 @@ import { Readable } from 'stream';
 import Mail = require('.');
 import MimeNode = require('../mime-node');
 
-declare class MailMessage {
-    mailer: Mail;
+declare class MailMessage<T = any> {
+    mailer: Mail<T>;
     data: Mail.Options;
     message: MimeNode;
 
-    constructor(mailer: Mail, data: Mail.Options);
+    constructor(mailer: Mail<T>, data: Mail.Options);
 
     resolveContent(data: object | any[], key: string | number, callback: (err: Error | null, value?: any) => any): Promise<any>;
 

nodemailer/lib/sendmail-transport/index.d.ts

@@ -28,10 +28,10 @@ declare namespace SendmailTransport {
     }
 }
 
-declare class SendmailTransport implements Transport {
+declare class SendmailTransport implements Transport<SendmailTransport.SentMessageInfo> {
     options: SendmailTransport.Options;
     logger: shared.Logger;
-    mailer: Mail;
+    mailer: Mail<SendmailTransport.SentMessageInfo>;
     name: string;
     version: string;
     path: string;
@@ -41,7 +41,7 @@ declare class SendmailTransport implements Transport {
     constructor(options: SendmailTransport.Options);
 
     /** Compiles a mailcomposer message and forwards it to handler that sends it */
-    send(mail: MailMessage, callback: (err: Error | null, info: SendmailTransport.SentMessageInfo) => void): void;
+    send(mail: MailMessage<SendmailTransport.SentMessageInfo>, callback: (err: Error | null, info: SendmailTransport.SentMessageInfo) => void): void;
 }
 
 export = SendmailTransport;

nodemailer/lib/ses-transport.d.ts

@@ -83,11 +83,11 @@ declare namespace SESTransport {
     }
 }
 
-declare class SESTransport extends EventEmitter implements Transport {
+declare class SESTransport extends EventEmitter implements Transport<SESTransport.SentMessageInfo> {
     options: SESTransport.Options;
 
     logger: shared.Logger;
-    mailer: Mail;
+    mailer: Mail<SESTransport.SentMessageInfo>;
 
     name: string;
     version: string;
@@ -100,13 +100,13 @@ declare class SESTransport extends EventEmitter implements Transport {
     sendingRateTTL: number | null;
     rateInterval: number;
     rateMessages: Array<{ ts: number, pending: boolean }>;
-    pending: Array<{ mail: Mail; callback(err: Error | null, info: SESTransport.SentMessageInfo): void; }>;
+    pending: Array<{ mail: Mail<SESTransport.SentMessageInfo>; callback(err: Error | null, info: SESTransport.SentMessageInfo): void; }>;
     idling: boolean;
 
     constructor(options: SESTransport.Options);
 
     /** Schedules a sending of a message */
-    send(mail: MailMessage, callback: (err: Error | null, info: SESTransport.SentMessageInfo) => void): void;
+    send(mail: MailMessage<SESTransport.SentMessageInfo>, callback: (err: Error | null, info: SESTransport.SentMessageInfo) => void): void;
 
     /** Returns true if there are free slots in the queue */
     isIdle(): boolean;

nodemailer/lib/smtp-pool/index.d.ts

@@ -43,10 +43,10 @@ declare namespace SMTPPool {
 /**
  * Creates a SMTP pool transport object for Nodemailer
  */
-declare class SMTPPool extends EventEmitter implements Transport {
+declare class SMTPPool extends EventEmitter implements Transport<SMTPPool.SentMessageInfo> {
     options: SMTPPool.Options;
 
-    mailer: Mail;
+    mailer: Mail<SMTPPool.SentMessageInfo>;
     logger: shared.Logger;
 
     name: string;
@@ -60,7 +60,7 @@ declare class SMTPPool extends EventEmitter implements Transport {
     getSocket(options: SMTPPool.Options, callback: (err: Error | null, socketOptions: any) => void): void;
 
     /** Sends an e-mail using the selected settings */
-    send(mail: MailMessage, callback: (err: Error | null, info: SMTPPool.SentMessageInfo) => void): void;
+    send(mail: MailMessage<SMTPPool.SentMessageInfo>, callback: (err: Error | null, info: SMTPPool.SentMessageInfo) => void): void;
 
     /** Closes all connections in the pool. If there is a message being sent, the connection is closed later */
     close(): void;

nodemailer/lib/smtp-transport.d.ts

@@ -53,10 +53,10 @@ declare namespace SMTPTransport {
     }
 }
 
-declare class SMTPTransport extends EventEmitter implements Transport {
+declare class SMTPTransport extends EventEmitter implements Transport<SMTPTransport.SentMessageInfo> {
     options: SMTPTransport.Options;
 
-    mailer: Mail;
+    mailer: Mail<SMTPTransport.SentMessageInfo>;
     logger: shared.Logger;
 
     name: string;
@@ -72,7 +72,7 @@ declare class SMTPTransport extends EventEmitter implements Transport {
     getAuth(authOpts: SMTPConnection.AuthenticationTypeLogin | SMTPConnection.AuthenticationTypeOAuth2): SMTPTransport.AuthenticationType;
 
     /** Sends an e-mail using the selected settings */
-    send(mail: MailMessage, callback: (err: Error | null, info: SMTPTransport.SentMessageInfo) => void): void;
+    send(mail: MailMessage<SMTPTransport.SentMessageInfo>, callback: (err: Error | null, info: SMTPTransport.SentMessageInfo) => void): void;
 
     /** Verifies SMTP configuration */
     verify(callback: (err: Error | null, success: true) => void): void;

nodemailer/lib/stream-transport.d.ts

@@ -32,11 +32,11 @@ declare namespace StreamTransport {
     }
 }
 
-declare class StreamTransport implements Transport {
+declare class StreamTransport implements Transport<StreamTransport.SentMessageInfo> {
     options: StreamTransport.Options;
 
     logger: shared.Logger;
-    mailer: Mail;
+    mailer: Mail<StreamTransport.SentMessageInfo>;
 
     name: string;
     version: string;
@@ -46,7 +46,7 @@ declare class StreamTransport implements Transport {
     constructor(options: StreamTransport.Options);
 
     /** Compiles a mailcomposer message and forwards it to handler that sends it */
-    send(mail: MailMessage, callback: (err: Error | null, info: StreamTransport.SentMessageInfo) => void): void;
+    send(mail: MailMessage<StreamTransport.SentMessageInfo>, callback: (err: Error | null, info: StreamTransport.SentMessageInfo) => void): void;
 }
 
 export = StreamTransport;

nodemailer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/nodemailer",
-    "version": "6.4.1",
+    "version": "6.4.2",
     "description": "TypeScript definitions for Nodemailer",
     "license": "MIT",
     "contributors": [
@@ -31,6 +31,6 @@
     "dependencies": {
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "bed126e5ff05dce39c1dc555eb5c910094ffc65169009f58ef5f41326de1a7a6",
+    "typesPublisherContentHash": "d82eae001ee70595c034fcffdcc5c37fd64ef3bcbd31451a0d2479d57fee0233",
     "typeScriptVersion": "3.5"
 }