index.d.ts

import { Attachment, ParsedMail } from "mailparser";
import { Stream } from "stream";

declare interface EmlParserOptions {
	ignoreEmbedded?: boolean;
	highlightKeywords?: string[];
	highlightCaseSensitive?: boolean;
}

declare interface EmailHeaders {
	subject: string;
	from: string;
	to: string;
	cc: string;
	date: Date;
	inReplyTo: string;
	messageId: string;
}

declare interface MessageHeaders {
	subject: string;
	from: Array<{ name: string; address: string }>;
	to: Array<{ name: string; address: string }>;
	cc: Array<{ name: string; address: string }>;
	date: Date;
}

export default class EmlParser {
	parsedEmail: ParsedMail | null;

	parseEml(options?: EmlParserOptions): Promise<ParsedMail>;
	parseMsg(): Promise<FieldsData>;
	getEmailHeaders(): Promise<EmailHeaders>;
	getMessageHeaders(): Promise<MessageHeaders>;
	getEmailBodyHtml(options?: EmlParserOptions): Promise<string>;
	getMessageBodyHtml(): Promise<string>;
	getEmailAsHtml(options?: EmlParserOptions): Promise<string>;
	getMessageAsHtml(): Promise<string>;
	convertEmailToStream(
		type?: string,
		orientation?: "portrait" | "landscape",
		format?: string,
		outerOptions?: EmlParserOptions
	): Promise<Stream>;
	convertMessageToStream(
		type?: string,
		orientation?: "portrait" | "landscape",
		format?: string,
		outerOptions?: EmlParserOptions
	): Promise<Stream>;
	convertEmailToBuffer(
		type?: string,
		orientation?: "portrait" | "landscape",
		format?: string,
		outerOptions?: EmlParserOptions
	): Promise<Buffer>;
	convertMessageToBuffer(
		type?: string,
		orientation?: "portrait" | "landscape",
		format?: string,
		outerOptions?: EmlParserOptions
	): Promise<Buffer>;
	getEmailAttachments(options?: EmlParserOptions): Promise<Attachment[]>;
	getMessageAttachments(): Promise<Attachment[]>;
	getEmailEmbeddedFiles(): Promise<Attachment[]>;
}