# sails-hook-mailin

> Sails hook for embedding an SMTP mail server

Latest version **1.0.2** (published 2015-07-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install sails-hook-mailin
pnpm add sails-hook-mailin
yarn add sails-hook-mailin
bun add sails-hook-mailin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2015-07-07 |
| First published | 2015-07-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Dan Prietti |
| Maintainers | dprietti |

## Links

- npm: https://www.npmjs.com/package/sails-hook-mailin
- Repository: https://github.com/dapriett/sails-hook-mailin
- Issues: https://github.com/dapriett/sails-hook-mailin/issues
- npm.io page: https://npm.io/package/sails-hook-mailin

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^3.10.0
- [mailin](https://npm.io/package/mailin.md) ^1.0.1

## Recent versions

- 1.0.2 (latest) — 2015-07-07
- 1.0.1 — 2015-07-06
- 1.0.0 — 2015-07-05
- 0.11.5 — 2015-07-05

## README

This provides a sails hook integrating [Mailin](http://mailin.io/) within your app.  Mailin is an smtp server that listens for emails and parses them as json.

[![NPM version][npm-image]][npm-url] [![Dependency status][david-dm-image]][david-dm-url]
[npm-url]: https://npmjs.org/package/sails-hook-mailin
[npm-image]: http://img.shields.io/npm/v/sails-hook-mailin.svg
[david-dm-url]:https://david-dm.org/dapriett/sails-hook-mailin
[david-dm-image]:https://david-dm.org/dapriett/sails-hook-mailin.svg

## Install
```sh
$ npm install sails-hook-mailin --save
```

## Usage

### 1. configure .sailsrc

```json
{
  "generators": {
    "modules": {
      "mailin-api": "sails-hook-mailin/generator"
    }
  }
}
```

### 2. install sails.js extension
```sh
$ sails generate mailin-api
```

This create the Mailin Service event handler, and config.  The default service name is `MailinService`, to use a different name instead use
```sh
$ sails generate mailin-api MyCustomMailinService
```

## Configuration
Simply modify the generated `config/mailin.js` to modify the options
```js
module.exports.mailin = {
  // Enable/Disable mail server
	enable: true,
	
	// Mail Port
	port: 2500,
	
	// Service to handle incoming mail 
	handlerService: MailinService
}
```

## Service Handler
Modify generated service handle, add methods for events you want to listen for

```js
// api/services/MailinService.js
module.exports = {

  // Validate email recipient
  validateRecipient: function (connection, email, callback) {
    if(email != "dprietti@test.com") return callback(new Error("Invalid Recipient"));

    callback();
  },


  // Message was received and parsed.
  message: function (connection, data, content) {
    console.log("New Message Received - Subject: " + data.subject);
  }

};
```

For all possible event methods, see [Mailin Events](https://github.com/Flolagale/mailin#events)

---
_Source: https://npm.io/package/sails-hook-mailin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._