https://github.com/pdroll/mailgun-send-cli
Quickly send HTML emails from the command line using the Mailgun API.
https://github.com/pdroll/mailgun-send-cli
Last synced: about 1 year ago
JSON representation
Quickly send HTML emails from the command line using the Mailgun API.
- Host: GitHub
- URL: https://github.com/pdroll/mailgun-send-cli
- Owner: pdroll
- License: mit
- Created: 2016-11-07T04:39:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:51:23.000Z (over 3 years ago)
- Last Synced: 2025-04-09T19:43:59.396Z (about 1 year ago)
- Language: JavaScript
- Size: 3.01 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# mailgun-send-cli
Easily send mail, even HTML emails, from the command line using the Mailgun API.
## Installation
```
npm install mailgun-send-cli -g
```
Note, this uses [mailgun.js](https://github.com/mailgun/mailgun-js) under the hood, which requires node.js >= 12.x. If you are using an older version of node, consider using an older version of this package. Version 0.2.0 requires node >=8, while version 0.1.4 requires node >=4.3.2.
```
npm install mailgun-send-cli@0.2.0 -g
```
## Usage
```
mailgun-send [options]
```
You will be prompted to enter your Mailgun [API Key](https://app.mailgun.com/app/account/security/api_keys) and [domain](https://app.mailgun.com/app/sending/domains/) on your first use. These values will be used on every subsequent call until the `--reset` flag is used to reset them.
### Examples
Plain text email:
```
mailgun-send -f me@example.com -t you@example.com -s 'Email sent via Mailgun from the command line' -T 'Hello there! The mailgun-send-cli tool is really cool. You should check it out!'
```
HTML email:
```
mailgun-send -f me@example.com -t you@example.com -s 'HTML Email sent via Mailgun from the command line' -H ~/path/to/html/file.html
```
### Options
#### `-s, --subject `
Subject of Email. Required.
#### `-t, --to `
Email address of recipient of email. Required.
#### `-f, --from `
Email address of email sender. Required.
#### `-r, --reply `
ReplyTo email address. Optional.
#### `-c, --cc `
Email address to CC. Optional.
#### `-b, --bcc `
Email address to BCC. Optional.
#### `-T, --text `
Text to send as body of email. Must specify this or `--htmlpath`.
#### `-H, --htmlpath `
Path to HTML file to send as email. Must specify this or `--text`.
#### `-R, --reset`
Reset Mailgun API key and Domain. You will be prompted to enter these again.
#### `-h, --help`
Output usage information
#### `-V, --version`
Output the version number
#### `-v, --verbose`
Output more detailed information, such as message id
## Troubleshooting
If it says your email was successfully sent, but you don't see the email in your inbox, check the [logs](https://mailgun.com/app/logs) of your mailgun account for more information.
Be sure to use a [verified domain](https://documentation.mailgun.com/quickstart-sending.html#verify-your-domain) to remove the "sent via Mailgun.org" message from your emails and increase your monthly free send limit from 300 to 10,000.
See [Mailgun's FAQ's](https://documentation.mailgun.com/faqs.html) for more information.