A command line interface for sending email, wrapped around nodemailer.
Install the module globally to expose the
nodemailer command to your
npm install -g nodemailer-cli
$ nodemailer --help Usage: nodemailer <to> <from> [bodyText] [options] to Email address, or comma separated list of email addresses to send mail to. from Email address that the message should be from. bodyText The plaintext message body. Options: -t, --service The nodemailer service identifier, if any. -u, --username The SMTP username to use when authenticating. [local_user_name] -p, --password The plain-text password to use when authenticating. -s, --server The SMTP server that mail will be delivered to. -r, --port The port to use when contacting the SMTP server. -n, --nossl If set, SSL will not be used when sending mail. -j, --subject The string to be used as the email's subject. --cc An email address to Carbon Copy. List multiple recipients by appending multiple --cc parameters. --bcc An email address to Blind Carbon Copy. List multiple recipients by appending multiple -bcc parameters. --replyTo An email address that should receive replies if a recipient replies to your message. --body A file to use as the message body. --attachment A path to a file that should be attached. List multiple attachments by appending multiple --attachment parameters. -v, --version Print version and exit.
Some environment variables can be used in place of CLI options. CLI options override these environment variables, if used, so these can be thought of as defaults.
- SMTP_SERVER The hostname of the SMTP server to be used.
- SMTP_PORT The port on the SMTP server that should be connected to.
- SMTP_USERNAME The username to use when authenticating.
- SMTP_PASSWORD The password to use when authenticating.
- SMTP_USE_SSL Set this to a truth-y value to use SSL.
- SMTP_USE_TLS Set this to a truth-y value to use TLS (STARTTLS)
- SMTP_SERVICE_NAME This is one of nodemailer's service identifiers, if you want it to configure itself automatically.
- Updates to support multiple
--attachmentparameters — @mistralol
- Updates to support multiple
- Fixes typo that would cause env vars to be ignored for useTLS — @mistralol
undefinedbeing passed for auth when no auth is specified. Thanks to @mistralol.
- Updates dependencies and adds dependency badge.
- Adds linter, gulp for running tests.
- Adds additional fields: cc, bcc, replyTo. Allows multiple emails as a comma-separated list in fields where it's sensible.
- Adds preferGlobal to the package, to warn if installed locally.
- Adds flag to print version of cli and nodemailer.
- Cleans up command line switches, and adds support for attachments.
- Initial Release.
The MIT License (MIT)
Copyright (c) 2014 Nathan Wittstock
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.