Send emails written in Markdown
Project description
nMdmail: Send emails written in Markdown
Fork of https://github.com/yejianye/mdmail, which looks dead.
nMdmail sends emails written in Markdown. It could be used as a standalone command-line script or as a python module. The features includes
- Have a sane default CSS style and support CSS customization
- Support local images as inline images
Screenshot of an email sent via nmdmail viewed in Google Inbox
To install nmdmail
$ python -m pip install nmdmail
Send Email in Command-line
When sending emails from command-line, the body of the email could be read from a file or stdin.
Email headers such as subject, from/to, cc etc could be specified at the beginning of the markdown file, Or be specified in command-line arguments.
Here is an example of Markdown file with email headers
Subject: Sample Email
From: foo@xyz.com
To: bar@xyz.com
Cc: baz@xyz.com
# Sample Email
-
![Embed local image](../assets/image.jpg)
To send this email with nmdmail
$ nmdmail sample_email.md
Here is an example of specifying subject, from/to in command-line
$ nmdmail --from=foo@xyz.com --to=bar@xyz.com --subject='Sample' sample_email.md
To read email content from stdin,
$ echo '# Sample Email' | nmdmail --from=foo@xyz.com --to=bar@xyz.com --subject='Sample'
SMTP server configurations are read from the following environment variables
export MDMAIL_HOST="" # default: localhost
export MDMAIL_PORT="" # default: 25
export MDMAIL_USE_TLS="" # default: false
export MDMAIL_USE_SSL="" # default: false
export MDMAIL_USERNAME="" # default: None
export MDMAIL_PASSWORD="" # default: None
export MDMAIL_DEFAULT_SENDER="" # default: None
Full help of nmdmail
command-line script
usage: nmdmail [-h] [--subject SUBJECT] [--from FROM_] [--to TO] [--cc CC]
[--bcc BCC] [--reply-to REPLY_TO] [--css CSS] [--print-only]
[file]
Send email written in Markdown.
positional arguments:
file Markdown file for email content. Default to STDIN.
optional arguments:
-h, --help show this help message and exit
--subject SUBJECT, -s SUBJECT
Subject line
--from FROM, -f FROM
From address
--to TO, -t TO To addresses, separated by comma
--cc CC, -c CC CC address, separated by comma
--bcc BCC, -b BCC Bcc address, separated by comma
--reply-to REPLY_TO, -r REPLY_TO
Reply-to address
--css CSS Use a custom CSS file
--print-only, -p Only print out rendered html
Send Email in Python Code
Sending emails in python is straight-forward.
import nmdmail
email="""
# Sample Email
- Python is awesome
- Markdown is cool
![Embed local image](../assets/image.jpg)
"""
nmdmail.send(email, subject='Sample Email',
from_email='foo@example.com', to_email='bar@example.com')
By default, it will use SMTP server on localhost. You could specify a SMTP server as well.
# Specify SMTP server
smtp = {
'host: 'my-mailserver.com',
'port': 25,
'tls': False,
'ssl': False,
'user: '',
'password': '',
}
nmdmail.send(content,
subject='Sample Email',
from_email='foo@example.com',
to_email='bar@example.com',
smtp=smtp)
API documentation nmdmail.send
- email (str/obj): A markdown string or EmailContent object
- subject (str): subject line
- from_email (str): sender email address
- to_email (str/list): recipient email addresses
- cc (str/list): CC email addresses (string or a list)
- bcc (str/list): BCC email addresses (string or a list)
- reply_to (str): Reply-to email address
- smtp (dict): SMTP configuration with following keys
- host (str): SMTP server host. Default: localhost
- port (int): SMTP server port. Default: 25
- tls (bool): Use TLS. Default: False
- ssl (bool): Use SSL. Default: False
- user (bool): SMTP login user. Default empty
- password (bool): SMTP login password. Default empty
Use nmdmail with Vim and Emacs
Since nmdmail
can read from stdin and support email headers such as subject/from/to in the markdown file itself,
integrating nmdmail with Vim, Emacs or other text editors is easy.
To use nmdmail in Vim, just write a markdown email with headers, and then execute w !nmdmail
command, which will send
current buffer as stdin to nmdmail.
In Emacs, you could write a small function to do the same thing
(defun nmdmail-send-buffer ()
(interactive)
(shell-command-on-region (point-min) (point-max) "nmdmail"))
Then M-x nmdmail-send-buffer
will send current buffer to nmdmail.
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
Built Distribution
File details
Details for the file nmdmail-0.4.0.tar.gz
.
File metadata
- Download URL: nmdmail-0.4.0.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-1036-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9bb9e1e87ab25123ad38cf0d2acff3f8603c2e9d4d09fcdbae3ff5973d0bf7f |
|
MD5 | 1e38a48074fb2ab9e6cdde17c9fa4507 |
|
BLAKE2b-256 | ded7023201b1b5ccf6b097f960be7ac2994d4b4b2e1f96decb02d9c3441eb7f3 |
File details
Details for the file nmdmail-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: nmdmail-0.4.0-py3-none-any.whl
- Upload date:
- Size: 8.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-1036-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5154a16773611e558e22114189595544e4165e42f98feefcf338b008c92dc0ef |
|
MD5 | 9155840f52179b9a86ab51d71569969f |
|
BLAKE2b-256 | dd59d494bc9d560817ba63b68464b52bdb3b9665fe35c62b1efa67ba5d8eb020 |