Package: maildown
MaildownA super simple CLI for sending emailsIntroductionMaildown is a command line interface that lets you send emails using Amazon AWS SES with a minimum of fussWhy can't I just useboto3?Maildown makes it easier to add structure and style to your email content. It supportsMarkdown syntaxout 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, whichisn'tcompletely 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 usagePre requisitesIn order to use Maildown, you first need to create an AWS free tier accounthere. Once you've signed up, you'll also realistically need totake your AWS SES account out of the sandboxInstall withpipYou can install maildown as follows:pipinstallmaildownAuthenticating MaildownMaildown stores your credentials locally for convenience. Before you can use Maildown's features, you should run themaildown initcommandmaildowninitAWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYIf you have previously used theaws cliand have already runaws configure, or if you have set the environment variablesAWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYin your environment, you can just usemaildown initwith no arguments to store your credentialsVerify email addressesAmazon 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 theSES console, or by using Maildown:$maildownverifychristopherdavies553@gmail.com
Emailsenttochristopherdavies553@gmail.com.YoumustclickthelinkinthisemailtoverifyownershipbeforeyoucansendanyemailsWhen 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$maildownverifychristopherdavies553@gmail.com
ThisemailaddresshasalreadybeenverifiedYou are now ready to start sending emails!Sending emailsYou can now send emails with the following commandmaildownsendchristopherdavies553@gmail.com"my email subject"-f"email.md"recipient1@gmail.comrecipient2@gmail.comThe above arguments, in order, are:The sending email address (which must have been verified)The subject line of your emailA markdown file containing some content to send. Note that you can also use the-cflag to pass string content to be sent directly to the email, e.g.-c "hello"A list of email addresses to send the content toContributingIf you'd like to contribute to this codebase, the latest dev builds are onPackagr. Get in touch to request access to theseStyling emailsBy 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--themeflag when sending mails, like this:maildownsendchristopherdavies553@gmail.com"my email subject"-f"email.md"--theme"my-style.css"recipient1@gmail.comrecipient2@gmail.com