<commit_before># mail-support

Check css support for the emails clients

**Wait stable version (v0.2.0) for install.**


## Options

- source_type
  - Type of source
  - 'file' or 'url'
  - Default -> 'file'


- source
  - source for test
  - 'path/to/source'
  - Default -> empty


- clients
  - filter clients for test
  - '*', ['gmail', 'ios'],
  - Default -> '*'


- reporter
  - type of result
  - 'json', 'tablelog'
  - Default -> tablelog


## Clients

| Client | Option |
| - | - |
| Android 4 (Gmail) | android |
| Apple Mail 6.5 | apple |
| Gmail (Web) | gmail |
| iPhone iOS 7/iPad | ios |
| Outlook 2007/10/13 | outlook |
| Outlook 03/Express/Mail | outlook_express |
| Outlook.com | outlook_web |
| Yahoo! Mail | yahoo |


## example

```js
import mailSupport from 'mail-support'

// mailSupport.test( source_type, source_dir, clients, reporter )

mailSupport.test('url', 'demo.com/style.css', '*', 'tablelog')

// result


mailSupport.test('file', './style.css', ['gmail', 'ios'], 'tablelog')

// result

```
<commit_msg>Fix readme<commit_after># mail-support

Check css support for the emails clients

**Wait stable version (v0.2.0) for install.**


## Options

- source_type
  - Type of source
  - 'file' or 'url'
  - Default -> 'file'


- source
  - source for test
  - 'path/to/source'
  - Default -> empty


- clients
  - filter clients for test
  - '*', ['gmail', 'ios'],
  - Default -> '*'


- reporter
  - type of result
  - 'json', 'tablelog'
  - Default -> tablelog


## Clients

| Client | Option |
| ------ | ------ |
| Android 4 (Gmail) | android |
| Apple Mail 6.5 | apple |
| Gmail (Web) | gmail |
| iPhone iOS 7/iPad | ios |
| Outlook 2007/10/13 | outlook |
| Outlook 03/Express/Mail | outlook_express |
| Outlook.com | outlook_web |
| Yahoo! Mail | yahoo |


## example

```js
import mailSupport from 'mail-support'

// mailSupport.test( source_type, source_dir, clients, reporter )

mailSupport.test('url', 'demo.com/style.css', '*', 'tablelog')

// result


mailSupport.test('file', './style.css', ['gmail', 'ios'], 'tablelog')

// result

```

{'fraction_non_alphanumeric': 0.17717862301396245, 'fraction_numerical': 0.01636976408281175, 'mean_word_length': 2.906015037593985, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3414267', 'n_tokens_mistral': 779, 'n_tokens_neox': 716, 'n_words': 197}