Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chris104957/maildown
A super simple CLI for sending emails
https://github.com/chris104957/maildown
Last synced: 7 days ago
JSON representation
A super simple CLI for sending emails
- Host: GitHub
- URL: https://github.com/chris104957/maildown
- Owner: chris104957
- License: mit
- Created: 2019-05-08T21:59:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T08:00:38.000Z (3 months ago)
- Last Synced: 2024-12-28T13:02:46.292Z (14 days ago)
- Language: Python
- Homepage: https://www.maildown.app/
- Size: 812 KB
- Stars: 582
- Watchers: 7
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - chris104957/maildown - A super simple CLI for sending emails (Python)
README
[](https://app.netlify.com/sites/adoring-newton-752f36/deploys)
[](https://coveralls.io/github/chris104957/maildown?branch=master)
[](https://travis-ci.org/chris104957/maildown)
[](https://gitspo.com/mentions/chris104957/maildown)
# Maildown
A super simple CLI for sending emails
## Introduction
Maildown is a command line interface that lets you send emails using Amazon AWS SES with a minimum of fuss
### Why can't I just use `boto3`?
Maildown makes it easier to add structure and style to your email content. It supports **Markdown syntax** out of the box, meaning that you can just send Markdown files as emails with no additional effort.
### How much does it cost?
Maildown is open source and therefore completely free. It relies on Amazon SES, which *isn't* completely free, but it does let you send up to 62,000 free emails per month (*when sent from an EC2 instance*). So for the vast majority of people, Maildown costs nothing to run.
## Installation and usage
### Pre requisites
In order to use Maildown, you first need to create an AWS free tier account [here](https://aws.amazon.com). Once you've signed up, you'll also realistically need to [take your AWS SES account out of the sandbox](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html)
### Install with `pip`
You can install maildown as follows:
```bash
pip install maildown
```
### Authenticating Maildown
Maildown stores your credentials locally for convenience. Before you can use Maildown's features, you should run the `maildown init` command
```bash
maildown init AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
```
> If you have previously used the `aws cli` and have already run `aws configure`, or if you have set the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` in your environment, you can just use `maildown init` with no arguments to store your credentials
### Verify email addresses
Amazon only lets you send emails from verified email addresses - In other words, you need to verify that you own your email address before you can send mails from it. You can either do this from the [SES console](https://console.aws.amazon.com/ses/home), or by using Maildown:
```bash
$ maildown verify [email protected]
Email sent to [email protected]. You must click the link in this email to verify ownership before you can send any emails
```
When you use the above command, AWS will send an email to the email address you provided. You'll need to click on the link to verify your ownership of the account. Once you've done this, you can repeat the previous command to check the status
```bash
$ maildown verify [email protected]
This email address has already been verified
```
You are now ready to start sending emails!
## Sending emails
You can now send emails with the following command
```bash
maildown send [email protected] "my email subject" -f "email.md" [email protected] [email protected]
```
The above arguments, in order, are:
- The sending email address (which must have been verified)
- The subject line of your email
- A markdown file containing some content to send. Note that you can also use the `-c` flag to pass string content to be sent directly to the email, e.g. `-c "hello"`
- A list of email addresses to send the content to
## Contributing
If you'd like to contribute to this codebase, the latest dev builds kept in a Private python package repository on [RepoForge.io](https://repoforge.io). Get in touch to request access to these
## Styling emails
By default, Maildown bakes in its own default style sheet when sending emails. This looks something like this (the below email is the content of this readme):
You can apply your own styles by simply using the `--theme` flag when sending mails, like this:
```bash
maildown send [email protected] "my email subject" -f "email.md" --theme "my-style.css" [email protected] [email protected]
```