email-signature-detector v0.0.6

Email Signature Detector

Extracts signatures from emails.

Usage

Node

Install: npm install email-signature-detector

const signature = require('email-signature-detector');

const body = `Dave,

See ticket #50366

Why do we issue this

Ron

Ron Smith
VP, Product Solutions
acme.com<http://acme.com/>
714.949.3001, rons@acme.com`;
  
const from = { email: 'rons@acme.com', displayName: 'Ron Smith' };
const ret = signature.getSignature(body,from);

Browser

TBD

API Reference

getSignature(body,from,bodyNoSig)

returns - { signature: the signature text, bodyNoSig: see optional bodyNoSig parameter below } body - contains the email body text from - optional: contains email and displayName used to detect the sender name in the signature. (see example in Usage) bodyNoSig - optional: if true the return object includes bodyNoSig : the email text until the beginning of the signature.

How does it work ?

Currently, the library implements a simple algorithm to detect candidate signature starts, and score each by examining the lines following the start.

For example, words such as Thanks and Regards, when used in short lines are considerd a candidate. the score of each candidate is determined by the content of the following lines, such as phone number, email address, url, sender name.

Note: The detectors of phone numbers, email addresses and urls are simple and their purpose is to support the signature scoring. They shouldn't be used standalone. refer to a specialized detector and validation libraries for that.