send-mail/README.md

44 lines
2.0 KiB
Markdown

------
**DISCLAIMER: This project is very much a Work In Progress. It is for meetup hosts pioneering Handmade Meetups. Hosts are expected to be programmers who are comfortable running and editing command-line programs. You can get help or give feedback in the [`#meetups`](https://discord.com/channels/239737791225790464/424523844016144394) channel of the [Handmade Network Discord](https://discord.gg/hmn).**
------
# send_mail
`send_mail.py` lets you email a [meetup group](https://handmadecities.com/meetups) using Handmade Cities branding. The script is for Handmade meetup hosts. You can send an invite to your meetup group like so:
`> python3 send_mail.py --subject SUBJECT --body BODY`
where SUBJECT is the subject of your email and BODY is the file containing its contents. Plain text or HTML is supported. Your email will automatically include the Handmade Cities branding along with unsubscribe links!
Note that you can dump the mailing list of your meetup group so far:
`> python3 send_mail.py --dump`
This list grows automatically as more people sign up for your city.
## app.ini
`send_mail` requires a companion `app.ini` file. It has the requisite secret credentials to be able to dump the mailing list and otherwise send the actual emails.
Below is how the file looks like. Note that anything secret is censored as `xxx`:
```
; User Constants - Update as needed
[DEFAULT]
LIVE = false
TEST_EMAIL = abner@terminal.click
SENDER_NAME = Abner Coimbre
; Handmade Cities Credentials - DON'T TOUCH
[hmc]
API_URL = https://api.handmadecities.com/v1/meetups/subscribers
SHARED_SECRET = xxx
CITY = Seattle
; Postmark App Credentials - NO TOUCHY TOUCHY
[postmark]
SERVER_TOKEN = xxx
API_URL = https://api.postmarkapp.com/email/batchWithTemplates
TEMPLATE_ID = xxx
SENDER_EMAIL = abner@handmadecities.com
MESSAGE_STREAM = xxx
```
`LIVE` is false by default, in which case the script only sends an email to the address in TEST_EMAIL. Set this to true when you're ready to mass-email your group.