Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yaroslaff/testmsg
Generate/send RFC-compliant e-mail messages. DKIM signed (optionally). Can send over SSL/TLS with authentication. Gmail.com and mail-tester.com are happy!
https://github.com/yaroslaff/testmsg
antispam body client craft dkim dkim-signing e-mail email generate headers mail message msmtp python rfc822 send smtp spam test testing
Last synced: 3 months ago
JSON representation
Generate/send RFC-compliant e-mail messages. DKIM signed (optionally). Can send over SSL/TLS with authentication. Gmail.com and mail-tester.com are happy!
- Host: GitHub
- URL: https://github.com/yaroslaff/testmsg
- Owner: yaroslaff
- License: mit
- Created: 2023-05-02T18:17:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T16:34:56.000Z (3 months ago)
- Last Synced: 2024-10-23T18:43:45.435Z (3 months ago)
- Topics: antispam, body, client, craft, dkim, dkim-signing, e-mail, email, generate, headers, mail, message, msmtp, python, rfc822, send, smtp, spam, test, testing
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-opensource-email - TestMSG - Generate RFC-compliant e-mail messages for sending over SMTP. DKIM signed (optionally). - `MIT`, `Python` (Sending / Email Testing Application)
README
# testmsg
Generate RFC822 compliant e-mail messages for tests and send it over SMTP.
While it's easy to send test messages like `echo asdf | mail [email protected]` or via `telnet mx.example.com 25` I need a tool which:
- Generates valid messages
- Messages should not look spammy or very suspicious
- Easy to use and repeat test
- Ability to customize messages
- Work well with msmtp or other full-featured SMTP client (e.g. which can send over secure SMTP connection with authentication)
- Support DKIM signatures
## Installation
For current user, using [pipx](https://github.com/pypa/pipx)
~~~
pipx install testmsg
~~~
or globally:
~~~
PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install testmsg
~~~
or (old way, better if inside virtualenv):
~~~
pip3 install testmsg
~~~
## Usage example
Just generate minimal valid message, print to stdout (not sending).
~~~
$ testmsg --to [email protected] --lorem
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Sent with github.com/yaroslaff/testmsg
From: [email protected]
To: [email protected]
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempo=
r incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut al=
iquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore =
eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia des=
erunt mollit anim id est laborum.
~~~
## Options
You can pass options either as command-line arguments or in `.env` file. Example:
~~~
[email protected]
[email protected]
SUBJECT="My subj"
# Only one of next three is possible at same time
# TEXT="Hello, world!"
# MSG=/tmp/helloworld.txt
LOREM=1
# add timestamp to message body
TIMESTAMP=1
# if we want to send message, set mailserver host there. Otherwise testmsg will just print to stdout
SEND=localhost
# You may override port (e.g. 587)
# PORT=25
# SMTP authentication
# If SMTPPASS given, will use SMTP authentication. Default SMTPUSER is same as FROM
# [email protected]
SMTPPASS="MySecretPassword"
# use 1 for True, anything else for False
SSL=0
STARTTLS=1
# DKIM (very very optional)
# DKIM_SELECTOR="mail"
# DKIM_PRIVKEY=/etc/ssl/private/test.example.com.pem
VERBOSE=1
~~~
To enable boolean option use value "1", to disable - any other value.
With such .env file, you can send message with just `testmsg` command (no options).
### Sending message
To actually send message via SMTP server add `--send localhost` and optionally add `-v` for verbosity.
~~~
testmsg -v --lorem --from [email protected] --to [email protected] --send localhost
~~~
See below about how to use authentication and SSL/TLS and how to use with `msmtp` (or other smtp clients).
### Customize message
Use `--from`, `--to` and `--subject` to override basic properties of message, use `--add HEADER VALUE` to add custom header(s).
To set `Return-Path` header (address used in `MAIL FROM` SMTP command) to custom value, use `-r` / `--return`, e.g. `--return [email protected]`.
Default message text is empty, use `--text "blah blah blah"` or `--lorem` or `--msg PATH` or `--msg -` .(to read from stdin). Add `--time` to add current time as an prefix to text.
### Add attachments
Use `--attachment` (or `--att`) to add attachments: `--att FILE1 FILE2 ...`
### Sign with DKIM
Generate DKIM RSA keys:
~~~shell
# generate private RSA key for DKIM
openssl genrsa -out example.com.pem 1024
# generate public key for DKIM
openssl rsa -in example.com.pem -out example.com.pub -pubout
~~~
Make DKIM DNS record with as `SELECTOR`._domainkey.example.com and verify it (here I decide to use selector `mail`):
~~~shell
$ host -t txt mail._domainkey.example.com
mail._domainkey.example.com.net descriptive text "v=DKIM1; h=sha256; k=rsa; p=MII...."
~~~
send DKIM signed message to gmail or mail-tester.com! Use `--selector` and `--privkey` arguments.
~~~shell
testmsg -f [email protected] -t [email protected] --lorem --selector mail --privkey example.com.pem -v --send localhost
~~~
## Use with authentication and SSL/STARTTLS SMTP servers
To use authentication, use `--user` and `--password` (or `--pass`) parameters. Use `--ssl` to use SSL-capable SMTP server (port 465), or use `--starttls` to use `STARTTLS` SMTP command. If neither `--ssl` nor `--starttls` is given, message and authentication credentials are sent over plain unencrypted connection, which is highly insecure.
If `--user` is not given (but `--password` given), testmsg will use username same as from (`--from` / `-f`) address.
Example:
~~~
testmsg -v -f [email protected] -t [email protected] --lorem --pass "MyTestPass" --send mx.example.com --starttls
~~~
## Use together with msmtp
Here we send with TLS and authentication (using [msmtp](https://github.com/marlam/msmtp)). Username for authentication (`--user`) is same as FROM address. Testmsg generates valid message and msmtp sends it.
~~~
[email protected]
[email protected]
testmsg -f $FROM -t $TO --lorem | msmtp -v --host smtp.office365.com --port 587 --user $FROM --passwordeval='echo MyTestPass' -f $FROM --tls=on --auth=on $TO
~~~