1.0.0 • Published 5 years ago

@alphahydrae/nodemailer-cli v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

Nodemailer CLI

Send mails from the command line with Nodemailer.

Usage

With npm:

npm install -g nodemailer-cli

nodemailer \
  --from bob@example.com --to alice@example.com \
  --text "Hello Alice" --smtp-host smtp.example.com

With npx:

npx nodemailer-cli \
  --from bob@example.com --to alice@example.com \
  --text "Hello Alice" --smtp-host smtp.example.com

With Docker:

docker run --rm -it alphahydrae/nodemailer \
  --from bob@example.com --to alice@example.com \
  --text "Hello Alice" --smtp-host smtp.example.com

Options

nodemailer [options]

Options:
  --version                 Show version number                        [boolean]
  --from, -f                Email of the sender                       [required]
  --subject, -s             Subject of the email         [default: "Nodemailer"]
  --text, -x                Body of the email                         [required]
  --to, -t                  Email(s) of the recipient(s), comma-separated if
                            there is more than one                    [required]
  --smtp-auth-user, -U      Username
  --smtp-auth-password, -P  Password
  --smtp-host, -h           SMTP host address                         [required]
  --smtp-ignore-tls         If this is true and smtp-secure is false then TLS is
                            not used even if the server supports STARTTLS
                            extension                           [default: false]
  --smtp-port, -p           SMTP port (defaults to 587 if is secure is false or
                            465 if true)                                [number]
  --smtp-proxy              TCP proxy address
  --smtp-require-tls        If this is true and secure is false then Nodemailer
                            tries to use STARTTLS even if the server does not
                            advertise support for it (if the connection can not
                            be encrypted then message is not sent)
                                                                [default: false]
  --smtp-secure             If true the connection will use TLS when connecting
                            to server, if false (the default) then TLS is used
                            if server supports the STARTTLS extension (in most
                            cases set this value to true if you are connecting
                            to port 465; keep it false for port 587 or 25)
                                                                [default: false]
  --help                    Show help                                  [boolean]