lettersanitizer
DOM-based HTML email sanitizer for in-browser email rendering.
Used in [react-letter](https://github.com/mat-sz/react-letter) and [vue-letter](https://github.com/mat-sz/vue-letter).
## Installation
**lettersanitizer** is available on [npm](https://www.npmjs.com/package/lettersanitizer), you can install it with either npm or yarn:
```sh
npm install lettersanitizer
# or:
yarn install lettersanitizer
```
## Example usage
```ts
import { sanitize } from 'lettersanitizer';
sanitize('test', '', { id: 'test' });
// test
```
### sanitize function
**lettersanitizer** exposes a `sanitize` function that uses DOMParser to sanitize the HTML content of messages and returns HTML text.
`text` is used for fallback text in case of no HTML source being available. Plain text in that case is processed into safe HTML output.
```ts
interface SanitizerOptions {
id?: string;
dropAllHtmlTags?: boolean;
rewriteExternalResources?: (url: string) => string;
rewriteExternalLinks?: (url: string) => string;
allowedSchemas?: string[];
preserveCssPriority?: boolean;
noWrapper?: boolean;
}
function sanitize(html: string, text?: string, options?: SanitizerOptions);
```