html-email-to-text
Version:
Convert html emails to (formatted) plain text
89 lines (76 loc) • 2.05 kB
Markdown
# html-email-to-text
Convert html emails to (formatted) plain text
## Install
```
$ npm install --save html-email-to-text
```
## Usage
```js
const htmlToText = require('html-email-to-text');
htmlToText('Html as a string');
//=> Formatted plain text as a string
```
## Examples
### HTML input
```html
<head>
<title>Subject line: Title will be uppercase</title>
</head>
<body>
<table>
<tr>
<td>
<table>
<tr>
<td>
<table>
<tr>
<td>Hello there</td>
</tr>
<tr>
<td>email coder</td>
</tr>
<tr>
<td>this is an example of </td>
</tr>
<tr>
<td>html-email-to-text formatting</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
This email can be formatted in plain text too.
<!-- whitespace and comments will be ignored -->
It works with a <a href="/links">link</a> or <a href="/another-link">two</a>.
</td>
</tr>
<tr>
<td>
If you wrap links around images it will use the alt text together with the link.
<a href="/link-to-somewhere"><img src="image.jpg" alt="alt text"></a>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>
```
### Text output
```
SUBJECT LINE: TITLE WILL BE UPPERCASE
--------------------
Hello there email coder this is an example of html-email-to-text formatting
This email can be formatted in plain text too.
It works with a link [/links] or two [/another-link].
If you wrap links around images it will use the alt text together with the link.
alt text
[/link-to-somewhere]
```
## License
MIT © [Andreas Nilsson](http://github.com/NaNdreas)