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

TypeScript definitions for nodemailer

/// <reference types="node" />

import { Transport, TransportOptions } from "../..";

import * as shared from "../shared";

import Mail = require("../mailer");
import MailMessage = require("../mailer/mail-message");
import MimeNode = require("../mime-node");

declare namespace SendmailTransport {
    type MailOptions = Mail.Options;

    interface Options extends MailOptions, TransportOptions {
        sendmail: true;
        /** path to the sendmail command (defaults to ‘sendmail’) */
        path?: string | undefined;
        /** either ‘windows’ or ‘unix’ (default). Forces all newlines in the output to either use Windows syntax <CR><LF> or Unix syntax <LF> */
        newline?: string | undefined;
        /** an optional array of command line options to pass to the sendmail command (ie. ["-f", "foo@blurdybloop.com"]). This overrides all default arguments except for ’-i’ and recipient list so you need to make sure you have all required arguments set (ie. the ‘-f’ flag). */
        args?: string[] | undefined;
    }

    interface SentMessageInfo {
        envelope: MimeNode.Envelope;
        messageId: string;
        response: string;
        accepted: Array<string | Mail.Address>;
        rejected: Array<string | Mail.Address>;
        pending: Array<string | Mail.Address>;
    }
}

declare class SendmailTransport implements Transport<SendmailTransport.SentMessageInfo> {
    options: SendmailTransport.Options;
    logger: shared.Logger;
    mailer: Mail<SendmailTransport.SentMessageInfo>;
    name: string;
    version: string;
    path: string;
    args: string[] | false;
    winbreak: boolean;

    constructor(options: SendmailTransport.Options);

    /** Compiles a mailcomposer message and forwards it to handler that sends it */
    send(
        mail: MailMessage<SendmailTransport.SentMessageInfo>,
        callback: (err: Error | null, info: SendmailTransport.SentMessageInfo) => void,
    ): void;
}

export = SendmailTransport;