Code Monkey home page Code Monkey logo

inbound-parse-multipart-parser's Introduction

inbound-parse-multipart-parser

A javascript/nodejs multipart/form-data parser which operates on data from SendGrid's Inbound Parse Webhook.

For example, a SendGrid Inbound Parse webhook pointing to an Azure Function

author

Cristian Salazar was the author of the original parser. You can find the original [here][https://github.com/freesoftwarefactory/parse-multipart#readme]. I, Allistair Vilakazi, just adapted the code to be able to parse the specific multipart/form-data format of SendGrid's Inbound Parse Webhook.

Background

Sometimes you only have access to the raw multipart payload and it needs to be parsed in order to extract the data contained on it. As an example: an Azure Function, which will operate as a facade between the http client (SendGrid Inbound Parse Webhook) and your response (sending a dynamic email using the SendGrid bindings and it's dynamic template).

The raw payload formatted as multipart/form-data will looks like this one:

...
--xYzZy
Content-Disposition: form-data; name="html"

<div dir=\"ltr\">This is the message body sent from an email.</div>
--xYzZY
Content-Disposition: form-data; name="from"

Allistair Vilakazi <[email protected]>
--xYzZY
Content-Disposition: form-data; name="text"

This is the message body sent from an email.
--xYzZY--

The lines above represents a raw multipart/form-data payload sent by the SendGrid Inbound Parse Webhook via email. We need to extract the all data contained inside it.

Usage

In the next lines you can see a implementation. In this case two key values needs to be present:

  • body, which can be:
--xYzZY
Content-Disposition: form-data; name="text"

This is the message body sent from an email.
--xYzZY--
  • boundary, the string which serve as a 'separator' between parts, it normally comes to you via headers. In this case, the boundary is:
	xYzZY

Now, having this two key values then you can implement it:

	var multipart = require('multipart.js');

	var body = Buffer.from(req.rawBody),'utf-8');
	
	var boundary = multipart.getBoundary(req.headers['content-type']);
	var parts = multipart.Parse(body,boundary);
	
	for(var i=0;i<parts.length;i++){
		var part = parts[i];
		// will be:
		// { name: 'text', data: 'This is the message body sent from an email.' }
	}

The returned data is an array of parts, each one described by a name and a data, this latter being a String.

inbound-parse-multipart-parser's People

Contributors

simply-alliv avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.