Repository files navigation

Reads email messages from a MBOX file. Output is an async generator where messages are yielded one by one.

MboxReader supports very large (multi gigabyte) mbox files as messages are processed asynchronously.

NB!mboxcl2 formatted mbox files are not supported as MboxReader assumes From-munging.

First install the module from NPM:

$ npm install mbox-reader

next import themboxReader generator function into your script:

const{ mboxReader}=require('mbox-reader');

mboxReader(readableStream, [options]) -> async generator

Where

• options is an optional options object
  • gz{Boolean} indicates if the input is a gz file (eg.gmail-takeout.mbox.gz). Default isfalse.

Generator yields objects with the following properties:

• returnPath Sender email address
• time Sending time as a Date object orfalse if date was not parseable
• content is a Buffer with the RFC822 formatted message
• flags an Array of IMAP compatible flags derived from Status or X-Status headers
• labels an Array of Gmail labels (ie. mailbox names) from X-Gmail-Labels headers
• headers a Map of headers where key is a lowercase header key and value is an array of header lines for this key (without the key prefix)

Example

Example reads mbox file from standard input and writes messages to console.

const{ mboxReader}=require('mbox-reader');forawait(letmessageofmboxReader(process.stdin)){console.log(message.returnPath);console.log(message.time);process.stdout.write(message.content);}

© 2020 - 2024 Postal Systems OÜ

Licensed under the MIT license.