mail-mime-builder/dist/commonjs/types.d.ts

RFC-2822, RFC-2045 and RFC-2049 compliant zero dependency raw email message generator.

export interface Mailbox {
    name: string;
    addr: string;
    type: MailboxType;
    reSpecCompliantAddr: RegExp;
    new (input: MailboxAddrObject | MailboxAddrText | Email, config: {
        type: MailboxType;
    }): Mailbox;
    getAddrDomain(): string;
    dump(): string;
    parse(input: MailboxAddrObject | MailboxAddrText | Email): Mailbox;
    isMailboxAddrText(v: unknown): v is MailboxAddrText;
    isMailboxAddrObject(v: unknown): v is MailboxAddrObject;
    isObject(v: unknown): v is object;
}
export type MailboxType = 'To' | 'From' | 'Cc' | 'Bcc' | 'Reply-To';
export type MailboxAddrObject = {
    addr: string;
    name?: string;
    type?: MailboxType;
};
export type MailboxAddrText = string;
export type Email = string;
export type HeaderField = {
    name: string;
    dump?: (v: string | Mailbox | Mailbox[] | undefined) => string;
    value?: string | Mailbox | undefined;
    validate?: (v: unknown) => boolean;
    required?: boolean;
    disabled?: boolean;
    generator?: () => string;
    custom?: boolean;
};
export type Boundaries = {
    mixed: string;
    alt: string;
    related: string;
};
export type ContentTransferEncoding = '7bit' | '8bit' | 'binary' | 'quoted-printable' | 'base64';
export type ContentHeaders = {
    'Content-Type'?: string;
    'Content-Transfer-Encoding'?: ContentTransferEncoding;
    'Content-Disposition'?: string;
    'Content-ID'?: string;
    [index: string]: string | undefined;
};
export type ContentOptions = {
    data: string;
    encoding?: ContentTransferEncoding;
    contentType: string;
    headers?: ContentHeaders;
    charset?: string;
};
export interface AttachmentOptions extends ContentOptions {
    inline?: boolean;
    filename: string;
}