Send Msg CLI

Send e-mail (and text messages) from the command line

Copyright © 2019 Teal Dulcet (both) and Daniel Connelly (Python)

Send e-mail (and text messages), with optional message and attachments, from the command line. Supports Unicode characters in the display names, subject, message and attachment filenames (MIME). Wrapper around cURL and the mail command to easily send e-mails from the command line. Optionally use your own e-mail address and an external SMTP server.

Useful to know when a cron job failed, when a long running job (LRP) has finished, to quickly backup/share a file or to send notifications as part of a larger script.

See the python directory for SendPy, a Python port of the script.

❤️ Please visit tealdulcet.com to support these scripts and my other software development.

Usage

Supports Unix, including both Linux and macOS. Requires at least Bash 4.4 and cURL, which are included on most Linux distributions.

Optional S/MIME digital signatures require OpenSSL.\ Optional PGP/MIME digital signatures require GNU Privacy Guard (GPG).\ Optional attachment compression requires the zip command.

Run: ./sendmsg.sh <OPTION(S)>... -s <subject>\ One or more To, CC or BCC e-mail addresses are required. Send text messages by using the mobile providers e-mail to SMS or MMS gateway. All the options can also be set by opening the script in an editor and setting the variables at the top. See Help below for full usage information.

1. Verify that the required commands above are installed.
2. Download the script (sendmsg.sh). Run: wget https://raw.github.com/tdulcet/Send-Msg-CLI/master/sendmsg.sh.
3. At a minimum, you need to provide one To e-mail address. If the computer is on a residential network or if it does not have an SMTP server setup then you will also need to provide an external SMTP server. For security, any passwords/passphrases should be set in the script, instead of on the command line.
4. Execute the script once to make sure there are no errors. For example, run: chmod u+x sendmsg.sh and ./sendmsg.sh -s "Test" -m "This is a test!" -t "Example <example@example.com>" -d.
5. If you want the script to be available for all users, install it. Run: sudo cp sendmsg.sh /usr/local/bin/sendmsg and sudo chmod +x /usr/local/bin/sendmsg.

Examples

See Help below for more examples.

Send a notification when a long running job (LRP) has finished, with the exit code and output: bash output=$(myLRP arg1 arg2… 2>&1); ./sendmsg.sh -s "“myLRP arg1 arg2…” has finished"'!' -m "The program “myLRP arg1 arg2…” has finished on “$HOSTNAME”"'!'"\nExit code: $?\nOutput:\n$output\n" Replace myLRP arg1 arg2… with the actual program and arguments.

Backup/Share a file: bash ./sendmsg.sh -s "Log file" -m "Please see the attached log file." -a status.log

Send notifications as part of a larger script: bash ./sendmsg.sh -s "⬇️ Example Website is DOWN"'!' -m "Example Website (https://www.example.com/) is currently DOWN"'!'"\n\nThis script will alert you when it is back up.\n" Example adapted from the Linux Remote Servers Status Monitoring Script.

Gmail

Feature comparison

* Optional\ † Only supported in Internationalizing Domain Names in Applications (IDNA) encoding

This is not a comprehensive list of the Send E-mail Script’s functionality.

Source: S-nail, Mutt, SSMTP, SendEmail (archived, source), eMail and smtp-cli

Help

``` $ sendmsg -h Usage: sendmsg ... -s or: sendmsg One or more To, CC or BCC e-mail addresses are required. Send text messages by using the mobile providers e-mail to SMS or MMS gateway (https://en.wikipedia.org/wiki/SMSgateway#Emailclients). All the options can also be set by opening the script in an editor and setting the variables at the top. See examples below.

Options: -s Subject Escape sequences are expanded. Supports Unicode characters. -m Message body Escape sequences are expanded. Supports Unicode characters. -a Attachment filename Use multiple times for multiple attachments. Supports Unicode characters in filename. -t To e-mail address Use multiple times for multiple To e-mail addresses. -c CC e-mail address Use multiple times for multiple CC e-mail addresses. -b BCC e-mail address Use multiple times for multiple BCC e-mail addresses. -f From e-mail address

-S <SMTP server>SMTP server
                    Supported protocols: "smtp" and "smtps". Requires From e-mail address. Use "smtp://localhost" if running a mail server on this device.
-u <username>   SMTP server username
-p <password>   SMTP server password
-P <priority>   Priority
                    Supported priorities: "5 (Lowest)", "4 (Low)", "Normal", "2 (High)" and "1 (Highest)". Requires SMTP server.
-r              Request Return Receipt
                    Requires SMTP server.
-C <certificate>S/MIME Certificate filename for digitally signing the e-mails
                    It will ask you for the password the first time you run the script with this option. Requires SMTP server.
-k <passphrase> PGP secret key passphrase for digitally signing the e-mails with PGP/MIME
                    Requires SMTP server.
-z <zipfile>    Compress attachment(s) with zip
-l              Set Content-Language
                    Uses value of LANG environment variable.
-U              Sanitize the Date
                    Uses Coordinated Universal Time (UTC) and rounds date down to whole minute. Set the TZ environment variable to change time zone.
-T <seconds>    Time to delay sending of the e-mail
-d              Dry run, do not send the e-mail
-V              Verbose, show the client-server communication
                    Requires SMTP server.

-h              Display this help and exit
-v              Output version information and exit

Examples: Send e-mail $ sendmsg -s "Example" -t "User user@example.com"

Send e-mail with message
$ sendmsg -s "Example" -m "This is an example!" -t "User <user@example.com>"

Send e-mail with message and single attachment
$ sendmsg -s "Example" -m "This is an example!" -a example.txt -t "User <user@example.com>"

Send e-mail with message and multiple attachments
$ sendmsg -s "Example" -m "This is an example!" -a example1.txt -a example2.txt -t "User <user@example.com>"

Send e-mail to a CC address
$ sendmsg -s "Example" -t "User 1 <user1@example.com>" -c "User 2 <user2@example.com>"

Send e-mail with a From address
$ sendmsg -s "Example" -f "Example <example@example.com>" -t "User <user@example.com>"

Send e-mail with an external SMTP server
$ sendmsg -s "Example" -f "Example <example@example.com>" -S "smtps://mail.example.com" -u "example" -p "password" -t "User <user@example.com>"

Send high priority e-mail
$ sendmsg -s "Example" -f "Example <example@example.com>" -S "smtps://mail.example.com" -u "example" -p "password" -P "1 (Highest)" -t "User <user@example.com>"

Send e-mail digitally signed with an S/MIME Certificate
$ sendmsg -s "Example" -f "Example <example@example.com>" -S "smtps://mail.example.com" -u "example" -p "password" -C "cert.p12" -t "User <user@example.com>"

Send e-mail digitally signed with PGP/MIME
$ sendmsg -s "Example" -f "Example <example@example.com>" -S "smtps://mail.example.com" -u "example" -p "password" -k "passphrase" -t "User <user@example.com>"

```

Scripts where this is incorporated

• Linux Remote Servers Status Monitoring Script

Contributing

Pull requests welcome! Ideas for contributions:

Bash: * Send e-mails with very long subjects or many e-mail addresses * Support International email addresses * Currently they are only supported in Internationalizing Domain Names in Applications (IDNA) encoding. * Support inputting the message body from standard input (stdin)

Python: * Do not create temporary files for performance and to reduce disk wear.

Both: * Improve the performance * Support HTML formatted messages * Provide an option to automatically upload large files to an external storage service, such as Send (provided by @timvisee, formerly Firefox Send) or transfer.sh * Add tests * Automatically renew the S/MIME certificate, as certbot does for Let's Encrypt certificates

Thanks to Daniel Connelly for helping create the Feature comparison and test the Bash script!