@ztimson/momentum
Version:
Client library for momentum
37 lines • 1.08 kB
TypeScript
import { PathEventEmitter } from './core';
import { Momentum } from './momentum';
import { RenderTemplate } from './templates';
/** Email model */
export type Mail = {
/** Message recipients */
to: string | string[];
/** Message subject/title */
subject?: string;
/** Leave blank or specify a from address if there are options */
from?: string;
/** Send copy to recipients */
cc?: string[];
/** Send copy to recipients silently */
bcc?: string[];
/** Email attachments */
attachments?: ({
filename: string;
content: Buffer;
} | {
path: string;
})[];
/** Email body or template */
body: string | RenderTemplate;
};
/** Send email */
export declare class Email extends PathEventEmitter {
protected momentum: Momentum;
constructor(momentum: Momentum);
/**
* Send an Email
* @param {Mail} email Email information
* @return {Promise<any>} SMTP Response
*/
create(email: Mail): import('@ztimson/utils').PromiseProgress<any>;
}
//# sourceMappingURL=email.d.ts.map