# mailchimp-releasemail

> Send automated release mails with a conventional changelog via MailChimp

Latest version **0.0.1** (published 2019-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install mailchimp-releasemail
pnpm add mailchimp-releasemail
yarn add mailchimp-releasemail
bun add mailchimp-releasemail
```

Provides the command `release-mail`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-02-11 |
| First published | 2019-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 60 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christiaan Scheermeijer |
| Maintainers | christiaan |

## Links

- npm: https://www.npmjs.com/package/mailchimp-releasemail
- npm.io page: https://npm.io/package/mailchimp-releasemail

## Dependencies (4)

- [meow](https://npm.io/package/meow.md) ^5.0.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.3
- [mailchimp-api-v3](https://npm.io/package/mailchimp-api-v3.md) ^1.12.1
- [conventional-changelog](https://npm.io/package/conventional-changelog.md) ^3.0.5

## Recent versions

- 0.0.1 (latest) — 2019-02-11

## README

# mailchimp-releasemail

Send automated release mails with Conventional Changelog via MailChimp.

## Prerequisites

- [MailChimp API Key](https://us1.admin.mailchimp.com/account/api/)
- [MailChimp list id](https://us1.admin.mailchimp.com/lists/)
- [MailChimp template id](https://us1.admin.mailchimp.com/templates/)
  * In order to use [Sections](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/), you must create a custom template.
  * Template id is a string
  * Use the `mc:edit="changelog"` section to inject the changelog

## CLI

If you want to use the CLI, you can install this package globally:

```
$ npm install mailchimp-releasemail -g
```

This will install the `release-mail` binary.

When using the CLI, it will automatically look for an `.releasemailrc` file in the current working directory. Your can change this by using the `--config` flag.

## .releasemailrc

The `.releasemailrc` file is a JavaScript file which will be required by the releasemail script. Below an example:

```
var pkg = require('./package.json');

module.exports = {
  apiKey:      process.env.MC_API_KEY,
  subject:     'Software release v' + pkg.version + ' 🚀',
  previewText: 'See all new features and bug fixes',
  listId:      '<mailchimp list id>',
  fromName:    'Your name',
  replyTo:     'your@email.com',
  templateId:  11223344,
  sections:    {
    version: 'v' + pkg.version,
  },
};
```

## Node

It is also possible to send release mails from your node script.

```
$ npm install mailchimp-releasemail
```

Now you can use it like so:

```
var releasemail = require('mailchimp-releasemail');
var pkg = require('./package.json');

releasemail({
  apiKey:      process.env.MC_API_KEY,
  subject:     'Software release v' + pkg.version + ' 🚀',
  previewText: 'See all new features and bug fixes',
  listId:      '<mailchimp list id>',
  fromName:    'Your name',
  replyTo:     'your@email.com',
  templateId:  11223344,
  sections:    {
    version: 'v' + pkg.version,
  },
}).then(function() {
  // success :-D
}).catch(function() {
  // error :-(
});
```

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