Skip to main content

Send a formatted email from the command line

Project description

Send Mail Via Python (smvp)

PyPI version Python versions License Status PyPI downloads


smvp logo

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 several use cases, but smvp was developed for two primary purposes:

  1. Configuring postfix and sendmail can be more setup than a small script needs.
  2. Cron scripts often need to email 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 resulting emails are nicely formatted. You could set $MAILTO in 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 cron and sending mail with smvp from within a script, make sure to include the environment variables at the top of your crontab so 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 using uv on 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

Maintainer Workflow

Run dependency upgrades from a clean worktree:

just upgrade

The command calls scripts/upgrade_dependencies.sh, upgrades dependencies, compares only first-order dependencies declared in pyproject.toml, and creates one local deps: Dependency Upgrades commit when direct locked versions changed. The commit body lists each direct dependency version change as old -> new. It does not push; review the local commit before pushing manually.

If only transitive locked dependencies changed, no commit is created and the dependency files are restored. Changelog generation groups deps: commits as Dependency Upgrades. Deprecated entries should use deprecate: or deprecated:.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smvp-0.4.3.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smvp-0.4.3-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file smvp-0.4.3.tar.gz.

File metadata

  • Download URL: smvp-0.4.3.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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

Hashes for smvp-0.4.3.tar.gz
Algorithm Hash digest
SHA256 b4ace7e32e72bc96820d3483d84375d368cebbf6e28f3348bf0e062beb09d822
MD5 be04caa84d90489a7a6d5bda5b0582b1
BLAKE2b-256 9ead840f964a2ff42a9d85565f556c2f526259c6e2bb2b22cc05f75a93d697d6

See more details on using hashes here.

File details

Details for the file smvp-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: smvp-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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

Hashes for smvp-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b5a8aa3b9d54511901078aa578ddefc360bdc11ff7c44e8d5e939abdc63ccf9
MD5 141937c7e5f020cce6ede5ab72d11357
BLAKE2b-256 81ac9143734c78812254ac97d98af3ee02cd9d36b0e26bb932b13e899887fc15

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page