Merge pull request DefinitelyTyped#33355 from ThePooN/mailparser-simpleparser-options

mailparser: Add options object to simpleParser

Author: jessetrinity

types/mailparser/index.d.ts

@@ -1,7 +1,7 @@
-// Type definitions for mailparser v2.0.0
-// Project: https://www.npmjs.com/package/mailparser
+// Type definitions for mailparser 2.4
+// Project: https://github.com/nodemailer/mailparser
 // Definitions by: Peter Snider <https://github.com/psnider>
-//                 Andrey Volynkin <https://github.com/Avol-V/>
+//                 Andrey Volynkin <https://github.com/Avol-V>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 /// <reference types="node" />
@@ -289,6 +289,13 @@ export class MailParser extends StreamModule.Transform {
  */
 export type Source = Buffer | Stream | string;
 
+/**
+ * Options object for simpleParser.
+ */
+export interface SimpleParserOptions extends StreamModule.TransformOptions {
+	keepCidLinks?: boolean;
+}
+
 /**
  * Parse email message to structure object.
  *
@@ -301,5 +308,16 @@ export function simpleParser(source: Source, callback: (err: any, mail: ParsedMa
  * Parse email message to structure object.
  *
  * @param source A message source.
+ * @param options Transform options passed to MailParser's constructor
+ * @param callback Function to get a structured email object.
+ */
+export function simpleParser(source: Source, options: SimpleParserOptions, callback: (err: any, mail: ParsedMail) => void): void;
+
+
+/**
+ * Parse email message to structure object.
+ *
+ * @param source A message source.
+ * @param options Transform options passed to MailParser's constructor
  */
-export function simpleParser(source: Source): Promise<ParsedMail>;
+export function simpleParser(source: Source, options?: SimpleParserOptions): Promise<ParsedMail>;

types/mailparser/mailparser-tests.ts

@@ -36,10 +36,16 @@ var sourceStream = fs.createReadStream('foo.eml');
 simpleParser(sourceString, (err, mail) => err ? err : mail.html);
 simpleParser(sourceBuffer, (err, mail) => err ? err : mail.html);
 simpleParser(sourceStream, (err, mail) => err ? err : mail.html);
+simpleParser(sourceString, { keepCidLinks: true }, (err, mail) => err ? err : mail.html);
+simpleParser(sourceBuffer, { keepCidLinks: true }, (err, mail) => err ? err : mail.html);
+simpleParser(sourceStream, { keepCidLinks: true }, (err, mail) => err ? err : mail.html);
 
 simpleParser(sourceString).then(mail => mail.html).catch(err => err);
 simpleParser(sourceBuffer).then(mail => mail.html).catch(err => err);
 simpleParser(sourceStream).then(mail => mail.html).catch(err => err);
+simpleParser(sourceString, { keepCidLinks: true }).then(mail => mail.html).catch(err => err);
+simpleParser(sourceBuffer, { keepCidLinks: true }).then(mail => mail.html).catch(err => err);
+simpleParser(sourceStream, { keepCidLinks: true }).then(mail => mail.html).catch(err => err);
 
 simpleParser(sourceString, (err, mail) => {
 	console.log(mail.headers.get('subject'));

types/mailparser/tslint.json

@@ -7,7 +7,7 @@
         "ban-types": false,
         "callable-types": false,
         "comment-format": false,
-        "dt-header": false,
+        "dt-header": true,
         "eofline": false,
         "export-just-namespace": false,
         "import-spacing": false,