mimeparser

mimeparser

Lib for parsing mime streams.

Scope

This is supposed to be a "low level" mime parsing module. No magic is performed on the data (eg. no joining HTML parts etc.). All body data is emitted out as Typed Arrays, so no need to perform any base64 or quoted printable decoding by yourself. Text parts are decoded to UTF-8 if needed.

Installation

npm:

npm install --save mimeparser

Dependencies

This module depends on mimefuncs and wo-addressparser . The dependency will be fetched automatically. Please use your require config accordingly.

Usage

AMD

var MimeParser = require('mimeparser');

non-AMD

<script src="mimeparser"></script>
// exposes MimeParser the constructor to the global object

Feed data to the parser

Feed data with write(chunk). Where chunk is supposed to be an Uint8Array or a 'binary' string.

parser.write('Subject: test\n\nHello world!');

When all data is feeded to the parser, call end()

parser.end();

Receiveing the output

You can receive the output by creating appropriate event handler functions.

Headers

To receive node headers, define onheader function

parser.onheader = function(node){
    console.log(node.header.join('\n')); // List all headers
    console.log(node.headers['content-type']); // List value for Content-Type
};

Body

Body is emitted in chunks of Typed Arrays, define onbody to catch these chunks

parser.onbody = function(node, chunk){
    console.log('Received %s bytes for %s', chunk.byteLength, node.path.join("."));
};

Parse end

When the parsing is finished, onend is called

parser.onend = function(){
    console.log('Parsing is finished');
};

Quirks

This seems like asynchronous but actually it is not. So always define onheader, onbody and onend before writing the first chunk of data to the parser.

message/rfc822 is automatically parsed if the mime part does not have a Content-Disposition: attachment header, otherwise it will be emitted as a regular attachment (as one long Uint8Array value).

Hands on

git clone [e-mail]:whiteout-io/mimeparser.git
cd mimeparser
npm install && npm test

License

Copyright (c) 2013 Andris Reinman

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.