Send a formatted email from the command line
Project description
Send Mail Via Python (smvp)
The smvp utility reads a file, uses its contents as the body of an
email, and sends it to a specified recipient. The input file can be a
text file with ANSI color codes, HTML, or plain text. The resulting
message is sent as a multipart MIME email that renders properly in both
plain text and HTML. The --content-type option can auto-detect the
input type or force it to be handled as plain text or HTML.
Note: The file itself is not sent as an attachment; instead, the contents of the file are put into the body of the email.
Compatibility
The smvp runtime is supported on Windows and Linux.
Project tooling remains Linux-only. That includes the just recipes,
the Bash scripts in scripts/, the release workflow, and the cron
examples below.
Use Case
There are probably several use cases, but I wrote smvp for two primary reasons:
- Configuring
postfixandsendmailwas more trouble than I wanted. - I want my cron scripts to email me status information and the
contents of various log files. Some of the files contain ANSI escape
sequences for terminal colors. The smvp utility converts those ANSI
escape sequences into styled HTML, so the emails I get are nicely
formatted. You could set
$MAILTOin your crontab, but you would not get proper handling of ANSI escape sequences, and you would still have the problem mentioned in item 1.
Installation
Use your preferred Python package installer for command line tools, for example:
pipx install smvp
or
uv tool install smvp
or
python -m venv .venv
# Linux / macOS
source .venv/bin/activate
# Windows PowerShell
.venv\Scripts\Activate.ps1
# Windows Command Prompt
.venv\Scripts\activate.bat
python -m pip install smvp
Requirements
SMTP Environment Variables
Set the following environment variables in the shell you are using
before running smvp.
Linux / macOS shells:
export SMVP_USER="<your email>" # e.g. "myemail@gmail.com"
export SMVP_TOKEN="<your token>" # e.g. "<gmail app password>"
export SMVP_SERVER="<smtp server>" # e.g. "smtp.gmail.com"
Windows PowerShell:
$env:SMVP_USER = "<your email>"
$env:SMVP_TOKEN = "<your token>"
$env:SMVP_SERVER = "<smtp server>"
Windows Command Prompt:
set SMVP_USER=<your email>
set SMVP_TOKEN=<your token>
set SMVP_SERVER=<smtp server>
If you want these variables to persist across sessions, add them to your shell profile or your Windows user environment settings.
Linux automation note:
Tip: If you're using
cronand sending mail with smvp from within a script, make sure to include the environment variables at the top of yourcrontabso your scripts will have access to them during execution. Also include a line in your script that exports the directory where your Python tool installer places executables. For example, if you're usinguvon Ubuntu, you could put something like this near the top of your bash script:
# Setup PATH export so the script can find installed Python tools
export PATH="$PATH:/home/<yourhome>/.local/bin"
SMTP Server
The SMVP_SERVER you select must support secure TLS connections on port
587. Check the SMTP settings for your email provider. This is the
default TLS port on Gmail, so if you are using your Gmail account to
send email, this requirement is usually already satisfied.
Styling
smvp offers custom font and font size options for your email. The
default font for formatted HTML email is Courier New, 12px. Beyond
the default, you can choose any font size from 2px up to and
including 100px, from the following font families:
"Andale Mono", "Arial", "Brush Script MT", "Comic Sans MS",
"Courier New", "Garamond", "Georgia", "Helvetica", "Impact",
"Luminari", "Monaco", "Tahoma", "Times New Roman", "Trebuchet MS",
"Verdana", "fantasy", "monospace", "sans-serif", "serif"
Note: Not every font will render properly on every device. When in doubt, fonts like: "monospace", "sans-serif", "fantasy", and "serif" are pretty safe. You may just have to try a few options to land on the right one for your use case.
Content Type
By default, smvp uses --content-type auto, which inspects the input
and decides whether to treat it as plain text or HTML. You can override
that behavior when needed:
auto Auto-detect whether the input should be treated as text or HTML
text Always treat the input as plain text, including HTML-like content
html Always treat the input as HTML
This is useful when the input contains angle brackets that should be sent literally, or when you want to force HTML rendering for a file that would not otherwise be detected as HTML.
Usage
usage: smvp [-h] [-c {auto,text,html}] [-f FONT_FAMILY] [-s FONT_SIZE] [-v] recipient subject file
For example:
smvp friend@gmail.com "Hello, Friend" ~/logfile.txt -f "Trebuchet MS" -s 14
On Windows, the same command works after installation. The only difference is the path style, for example:
smvp friend@gmail.com "Hello, Friend" .\logfile.txt -f "Trebuchet MS" -s 14
Force plain-text handling for HTML-like input:
smvp friend@gmail.com "Raw Markup" ./snippet.txt --content-type text
Force HTML handling:
smvp friend@gmail.com "Rendered Markup" ./fragment.txt --content-type html
For more details, run:
smvp -h
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file smvp-0.4.1.tar.gz.
File metadata
- Download URL: smvp-0.4.1.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a277324f14fec532e8fc1d6d248b07bea23528e14d93cba35c0f9a05c0bbd315
|
|
| MD5 |
6015ab0c7b01bdfde97c9f8de91c2464
|
|
| BLAKE2b-256 |
678d0339a988182cea05b198eb45925b0796ddef6acbfa0cf9a948251e04987d
|
File details
Details for the file smvp-0.4.1-py3-none-any.whl.
File metadata
- Download URL: smvp-0.4.1-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3238c80c391fc7fe5e163e27668ee6833a78b2187a12edad62dd4cab4f4b9229
|
|
| MD5 |
82039d1710d31fc5a9403339de7f4b25
|
|
| BLAKE2b-256 |
acd3961a0dbf377ee951828abe37917bf60db4d9b6b010ccf54bf21fce2e5c6b
|