# secret-santa-module

> Secret santa shuffler and email sender

Latest version **3.2.0** (published 2016-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install secret-santa-module
pnpm add secret-santa-module
yarn add secret-santa-module
bun add secret-santa-module
```

## Health

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

Positive: no vulnerabilities.

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

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2016-03-10 |
| First published | 2015-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | DKunin |
| Maintainers | dkunin |

## Links

- npm: https://www.npmjs.com/package/secret-santa-module
- Repository: https://github.com/DKunin/secret-santa-module
- Homepage: https://github.com/DKunin/secret-santa-module#readme
- Issues: https://github.com/DKunin/secret-santa-module/issues
- npm.io page: https://npm.io/package/secret-santa-module

## Dependencies (7)

- [winston](https://npm.io/package/winston.md) ^2.1.1
- [neat-csv](https://npm.io/package/neat-csv.md) ^1.1.0
- [nodemailer](https://npm.io/package/nodemailer.md) ^1.10.0
- [path-exists](https://npm.io/package/path-exists.md) ^2.1.0
- [blueimp-tmpl](https://npm.io/package/blueimp-tmpl.md) ^3.3.0
- [secret-santa-shuffler](https://npm.io/package/secret-santa-shuffler.md) git+ssh://git@github.com/DKunin/secret-santa-shuffler.git
- [nodemailer-mailgun-transport](https://npm.io/package/nodemailer-mailgun-transport.md) ^1.0.1

## Recent versions

- 3.2.0 (latest) — 2016-03-10
- 3.1.0 — 2016-03-10
- 2.2.2 — 2015-12-15
- 2.2.1 — 2015-12-11
- 2.1.1 — 2015-12-11
- 2.1.0 — 2015-12-11
- 2.0.0 — 2015-12-11
- 1.0.1 — 2015-12-11
- 1.0.0 — 2015-12-11

## README

# Secret Santa Module

## Installation

      npm i secret-santa-module -S

## Usage
```javascript
  var fs = require('fs');
  var path = require('path');
  var list = fs.readFileSync(path.resolve('./test-list.csv')).toString();
  var santaModule = require('secret-santa-module');
  
  // Your MailGun Credentials
  var auth = {
    api_key: <YOUR API KEY>,
    domain: <YOUR DOMAIN>
  };

  santaModule(list, {
      auth: auth,
      debug: false,
      template: '<div><h2>Custom template!</h2><div>You should prepeare for <h3>{%=o.to%}</h3></div></div>'
  });
```
## List Example

      // NOTE : The first line is mandatory
      Name,e-mail
      Barry Allen,flash@dccomics.com
      Wally West ,kidflash@dccomics.com

## Sent message
  
  You should prepare a present for:
  Wally West (kidflash@dccomics.com)

## Changelog

### 3.2.0
- Breaking changes: replaced jade templater for simple string templater
- Breaking changes: removed jade
- Breaking changes: removed ramda

### 3.0.0
- Breaking changes: you should provide csv string instead of a filename
- You can provide custom template option jade string

## TODO 
- ~~Custom templates~~
- Templates without jade or Automatic conversation from HTML to jade

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