@types/nodemailer 6.1.1 → 6.4.0

nodemailer/README.md

@@ -2,15 +2,15 @@
 > `npm install --save @types/nodemailer`
 
 # Summary
-This package contains type definitions for Nodemailer ( https://github.com/nodemailer/nodemailer ).
+This package contains type definitions for Nodemailer (https://github.com/nodemailer/nodemailer).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nodemailer
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nodemailer.
 
-Additional Details
- * Last updated: Fri, 24 May 2019 16:40:13 GMT
- * Dependencies: @types/node
+### Additional Details
+ * Last updated: Wed, 18 Dec 2019 16:21:54 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Rogier Schouten <https://github.com/rogierschouten>, Piotr Roszatycki <https://github.com/dex4er>, Daniel Chao <https://github.com/bioball>.
+These definitions were written by Rogier Schouten (https://github.com/rogierschouten), Piotr Roszatycki (https://github.com/dex4er), and Daniel Chao (https://github.com/bioball).

nodemailer/index.d.ts

@@ -1,10 +1,10 @@
-// Type definitions for Nodemailer 6.1
+// Type definitions for Nodemailer 6.4
 // Project: https://github.com/nodemailer/nodemailer, https://nodemailer.com
 // Definitions by: Rogier Schouten <https://github.com/rogierschouten>
 //                 Piotr Roszatycki <https://github.com/dex4er>
 //                 Daniel Chao <https://github.com/bioball>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3
+// TypeScript Version: 3.3
 
 /// <reference types="node" />
 

nodemailer/lib/addressparser.d.ts

@@ -3,6 +3,13 @@ declare namespace addressparser {
         name: string;
         address: string;
     }
+
+    interface Group {
+        name: string;
+        group: AddressOrGroup[];
+    }
+
+    type AddressOrGroup = Address | Group;
 }
 
 /**
@@ -18,6 +25,7 @@ declare namespace addressparser {
  *
  * @return An array of address objects
  */
-declare function addressparser(address: string): addressparser.Address[];
+declare function addressparser(address: string, options: { flatten: true }): addressparser.Address[];
+declare function addressparser(address: string, options?: { flatten: false }): addressparser.AddressOrGroup[];
 
 export = addressparser;

nodemailer/lib/mime-node/index.d.ts

@@ -87,8 +87,9 @@ declare class MimeNode {
      */
     setContent(content: string | Buffer | Readable): this;
 
-    /** Generate the message and return it with a callback */
+    /** Generate the message and return it with a callback or promise */
     build(callback: (err: Error | null, buf: Buffer) => void): void;
+    build(): Promise<Buffer>;
 
     getTransferEncoding(): string;
 

nodemailer/lib/ses-transport.d.ts

@@ -12,8 +12,57 @@ import MimeNode = require('./mime-node');
 
 declare namespace SESTransport {
     interface MailOptions extends Mail.Options {
-        /** All keys are added to the SendRawEmail method options */
-        ses?: object;
+        /** list of keys that SendRawEmail method can take */
+        ses?: MailSesOptions;
+    }
+
+    interface MailSesOptions {
+        /**
+         * The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)  Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.  If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
+         */
+        Source?: string;
+        /**
+         * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
+         */
+        Destinations?: string[];
+        /**
+         * The raw email message itself. The message has to meet the following criteria:   The message has to contain a header and a body, separated by a blank line.   All of the required header fields must be present in the message.   Each part of a multipart MIME message must be formatted properly.   Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.   The entire message must be base64-encoded.   If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.   Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
+         */
+        RawMessage?: {
+            /**
+             * The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail.   Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.  For more information, go to the Amazon SES Developer Guide.
+             */
+            Data: Buffer|Uint8Array|{}|string;
+        };
+        /**
+         * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.  For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
+         */
+        FromArn?: string;
+        /**
+         * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.  For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
+         */
+        SourceArn?: string;
+        /**
+         * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.  For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
+         */
+        ReturnPathArn?: string;
+        /**
+         * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
+         */
+        Tags?: Array<{
+            /**
+             * The name of the tag. The name must:   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).   Contain less than 256 characters.
+             */
+            Name: string;
+            /**
+             * The value of the tag. The value must:   This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).   Contain less than 256 characters.
+             */
+            Value: string;
+        }>;
+        /**
+         * The name of the configuration set to use when you send an email using SendRawEmail.
+         */
+        ConfigurationSetName?: string;
     }
 
     interface Options extends MailOptions, TransportOptions {

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

@@ -22,17 +22,23 @@ declare namespace SMTPConnection {
 
     type OAuth2 = XOAuth2.Options;
 
+    interface AuthenticationTypeCustom extends Credentials {
+        /** indicates the authetication type, defaults to ‘login’, other option is ‘oauth2’ or ‘custom’ */
+        type: 'custom' | 'Custom' | 'CUSTOM';
+        method: string;
+    }
+
     interface AuthenticationTypeLogin extends Credentials {
-        /** indicates the authetication type, defaults to ‘login’, other option is ‘oauth2’ */
+        /** indicates the authetication type, defaults to ‘login’, other option is ‘oauth2’ or ‘custom’ */
         type?: 'login' | 'Login' | 'LOGIN';
     }
 
     interface AuthenticationTypeOAuth2 extends OAuth2 {
-        /** indicates the authetication type, defaults to ‘login’, other option is ‘oauth2’ */
+        /** indicates the authetication type, defaults to ‘login’, other option is ‘oauth2’ or ‘custom’ */
         type?: 'oauth2' | 'OAuth2' | 'OAUTH2';
     }
 
-    type AuthenticationType = AuthenticationTypeLogin | AuthenticationTypeOAuth2;
+    type AuthenticationType = AuthenticationTypeCustom | AuthenticationTypeLogin | AuthenticationTypeOAuth2;
 
     interface AuthenticationCredentials {
         /** normal authentication object */
@@ -44,6 +50,30 @@ declare namespace SMTPConnection {
         oauth2: OAuth2;
     }
 
+    interface CustomAuthenticationResponse {
+        command: string;
+        response: string;
+        status: number;
+        text: string;
+        code?: number;
+    }
+
+    interface CustomAuthenticationContext {
+        auth: AuthenticationCredentials;
+        authMethod: string;
+        extensions: string[];
+        authMethods: string[];
+        maxAllowedSize: number | false;
+        sendCommand(cmd: string): Promise<CustomAuthenticationResponse>;
+        sendCommand(cmd: string, done: (err: Error | null, data: CustomAuthenticationResponse) => void): void;
+        resolve(): unknown;
+        reject(err: Error | string): unknown;
+    }
+
+    interface CustomAuthenticationHandlers {
+        [method: string]: (ctx: CustomAuthenticationContext) => Promise<boolean> | unknown;
+    }
+
     type DSNOption = 'NEVER' | 'SUCCESS' | 'FAILURE' | 'DELAY';
 
     interface DSNOptions {
@@ -137,6 +167,7 @@ declare namespace SMTPConnection {
         socket?: net.Socket;
         /** connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plaintext to ciphertext */
         connection?: net.Socket;
+        customAuth?: CustomAuthenticationHandlers;
     }
 }
 

nodemailer/lib/smtp-transport.d.ts

@@ -13,6 +13,11 @@ import SMTPConnection = require('./smtp-connection');
 import XOAuth2 = require('./xoauth2');
 
 declare namespace SMTPTransport {
+    interface AuthenticationTypeCustom extends SMTPConnection.Credentials {
+        type: 'CUSTOM';
+        method: string;
+    }
+
     interface AuthenticationTypeLogin {
         type: 'LOGIN';
         user: string;

nodemailer/lib/xoauth2.d.ts

@@ -30,6 +30,7 @@ declare namespace XOAuth2 {
         timeout?: s;
         /** Function to run when a new access token is required */
         provisionCallback?(user: string, renew: boolean, callback: (err: Error | null, accessToken: string, expires: number) => void): void;
+        serviceClient?: string;
     }
 
     interface Token {
@@ -49,7 +50,7 @@ declare class XOAuth2 extends Stream {
     accessToken: string | false;
     expires: number;
 
-    constructor(options: XOAuth2.Options, logger: shared.Logger);
+    constructor(options?: XOAuth2.Options, logger?: shared.Logger);
 
     /** Returns or generates (if previous has expired) a XOAuth2 token */
     getToken(renew: boolean, callback: (err: Error | null, accessToken: string) => void): void;
@@ -71,7 +72,12 @@ declare class XOAuth2 extends Stream {
      * As we do only a simple POST request we do not actually require complicated
      * logic support (no redirects, no nothing) anyway.
      */
-    postRequest(url: string, payload: string | Buffer | Readable | { [key: string]: string }, params: XOAuth2.RequestParams, callback: (err: Error | null, buf: Buffer) => void): void;
+    postRequest(
+        url: string,
+        payload: string | Buffer | Readable | { [key: string]: string },
+        params: XOAuth2.RequestParams,
+        callback: (err: Error | null, buf: Buffer) => void
+    ): void;
 
     /** Encodes a buffer or a string into Base64url format */
     toBase64URL(data: Buffer | string): string;

nodemailer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/nodemailer",
-    "version": "6.1.1",
+    "version": "6.4.0",
     "description": "TypeScript definitions for Nodemailer",
     "license": "MIT",
     "contributors": [
@@ -21,7 +21,7 @@
         }
     ],
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
         "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
@@ -31,6 +31,6 @@
     "dependencies": {
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "a650b914d963a357341d26b2b50c6d64832f6a849206656e6fc18c586532ab7f",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "0039445f01109c0e68106090b3609cab060c769ad2516b099fdafdb8ca22d4a0",
+    "typeScriptVersion": "3.3"
 }