planerRemove reply quotations from emails.
At lever we are into simple machines. A planer removes some material to flatten out a rough surface, which seemed appropriate for a module that smooths out an email to extract the actual message.
talonpython library. Planer does not do signatures, though there is a node port of that part of talon.
InstallationUse npm to install planer (add
-gif you would like it to be global):
npm install planer
UsageImportant: planer accepts an injected Document object to perform html parsing. You can use
window.documentin a browser, or something akin to
jsdomon the server. We use
jsdomin our test suite.
To extract the message from a plain text email:
planer = require('planer'); msgBody = "Reply!\n\nOn 15-Dec-2011, at 6:54 PM, Sean Carter <email@example.com> wrote:\n> It's the ROC!\n>-Sean"; actualMessage = planer.extractFrom(msgBody, 'text/plain'); console.log(actualMessage); # "Reply!"
To extract the message from an html email:
planer = require('planer'); msgBody = 'Reply!\n<div>\nOn 11-Apr-2011, at 6:54 PM, Bob <firstname.lastname@example.org> wrote:\n</div>\n<blockquote>\n<div>\nTest\n</div>\n</blockquote>'; actualMessage = planer.extractFrom(msgBody, 'text/html', window.document); console.log(actualMessage) # "<html><body>Reply!\n</body></html>";
ContributingContributions are of course encouraged. Keep in mind that the source is the
/libare kept around for convenience.
Write tests for any new functionality. Run
MIT LicenceCopyright (c) 2015 Leighton Wallace
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.