Mailspring/app/internal_packages/phishing-detection/README.md
2017-09-05 13:40:25 -07:00

19 lines
568 B
Markdown

## Phishing Detection
A sample package for Mailspring to detect simple phishing attempts. This package display a simple warning if
a message's originating address is different from its return address. The warning looks like this:
![screenshot](./screenshot.png)
#### Who is this for?
This package is our slimmest example package. It's annotated for developers who have no experience with React, Flux, Electron, or N1.
#### To build documentation (the manual way)
```
cjsx-transform lib/main.cjsx > docs/main.coffee
docco docs/main.coffee
rm docs/main.coffee
```