Compare commits
6 commits
bbe48d2c38
...
d268720796
| Author | SHA1 | Date | |
|---|---|---|---|
| d268720796 | |||
| 746e44942f | |||
| 754184628e | |||
| b05a1079d6 | |||
| 78e74d5ae9 | |||
| 4f4fc2b609 |
6 changed files with 59 additions and 16 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -3,3 +3,4 @@ vars.py
|
|||
message.html
|
||||
.DS_Store
|
||||
*.pyc
|
||||
venv
|
||||
33
README.md
33
README.md
|
|
@ -2,16 +2,27 @@
|
|||
|
||||
Easily send mails via SMTP and python
|
||||
|
||||
## Setup
|
||||
1. Copy `vars.py.example` to `vars.py`
|
||||
2. Setup `vars.py` with your credentials and config
|
||||
3. Adapt `message.htmt` and save your contact list to `contacts.csv`
|
||||
## Installation
|
||||
To install the requirements, run the following command
|
||||
```
|
||||
python -m pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
```python mail.py```
|
||||
|
||||
### Setup
|
||||
1. Copy `vars.py.example` to `vars.py`
|
||||
2. Setup `vars.py` with your credentials and config
|
||||
3. Adapt `message.html` and save your contact list to `contacts.csv`
|
||||
|
||||
### Send mail
|
||||
Just run
|
||||
```sh
|
||||
python mail.py
|
||||
```
|
||||
|
||||
## Templating
|
||||
You can use the keys from your `csv` directly, prepending a `$` sign. For example:
|
||||
You can use the keys from your `csv` directly, prepending a `$` sign (case sensitive!). For example:
|
||||
```
|
||||
Hello $name, your value is $value!
|
||||
```
|
||||
|
|
@ -24,3 +35,13 @@ With a `contacts.csv` looking like:
|
|||
| name | value |
|
||||
|--------|-------|
|
||||
| h4xx0r | 1337 |
|
||||
|
||||
## Options
|
||||
### Sending behavior
|
||||
Some mail servers will block the requests, if too many are sent too fast. You can use the variables to add delays:
|
||||
- `WAIT_EVERY` the amount of mails sent at once
|
||||
- `DELAY_SEC` the amount of seconds to wait between sending the next batch
|
||||
|
||||
### Other options
|
||||
- `LOGLEVEL` the logging level, set to `'DEBUG'` for most output
|
||||
- `DRY_RUN` if set to `True`, the mails wont get sent, but the output is generated as if they would be sent. Good for testing and best to use with `LOGLEVEL = 'DEBUG'`
|
||||
22
mail.py
22
mail.py
|
|
@ -1,10 +1,9 @@
|
|||
import logging
|
||||
import smtplib
|
||||
import time
|
||||
|
||||
from string import Template
|
||||
|
||||
from email.mime.multipart import MIMEMultipart
|
||||
from email.mime.text import MIMEText
|
||||
from string import Template
|
||||
|
||||
import pandas as pd
|
||||
|
||||
|
|
@ -17,6 +16,8 @@ def get_contacts(filename):
|
|||
read from a file specified by filename.
|
||||
"""
|
||||
|
||||
logging.debug(f'Loading contacts from {filename}...')
|
||||
|
||||
return pd.read_csv(filename)
|
||||
|
||||
|
||||
|
|
@ -32,6 +33,10 @@ def read_template(filename):
|
|||
|
||||
|
||||
def main():
|
||||
logging.basicConfig(level=LOGLEVEL, format='%(asctime)s - %(levelname)s - %(message)s')
|
||||
|
||||
logging.info('Starting pymail')
|
||||
|
||||
contacts = get_contacts('contacts.csv')
|
||||
message_template = read_template('message.html')
|
||||
|
||||
|
|
@ -39,10 +44,13 @@ def main():
|
|||
s = smtplib.SMTP(HOST, PORT)
|
||||
s.starttls()
|
||||
s.login(MY_ADDRESS, PASSWORD)
|
||||
logging.debug('Mail server is set up.')
|
||||
|
||||
logging.info(f'Starting to send mails to {len(contacts.index)} recipients, this might take a while...')
|
||||
|
||||
# For each contact, send the email:
|
||||
for i in contacts.index:
|
||||
print(f"Sending email {i+1}\n")
|
||||
logging.info(f"Sending email {i+1} of {len(contacts.index)}\n")
|
||||
msg = MIMEMultipart() # create a message
|
||||
|
||||
# add in the actual person name to the message template
|
||||
|
|
@ -50,7 +58,7 @@ def main():
|
|||
message = message_template.substitute(contact_dict)
|
||||
|
||||
# Prints out the message body for our sake
|
||||
print(f"{message}\n")
|
||||
logging.debug(f"{message}\n")
|
||||
|
||||
# setup the parameters of the message
|
||||
msg['From'] = MY_ADDRESS
|
||||
|
|
@ -60,16 +68,20 @@ def main():
|
|||
# add in the message body
|
||||
msg.attach(MIMEText(message, 'html'))
|
||||
|
||||
if not DRY_RUN:
|
||||
# send the message via the server set up earlier.
|
||||
s.send_message(msg)
|
||||
del msg
|
||||
|
||||
# Wait for DELAY_SEC seconds every WAIT_EVERY-th message
|
||||
if (i + 1) % WAIT_EVERY == 0:
|
||||
time.sleep(DELAY_SEC)
|
||||
|
||||
# Terminate the SMTP session and close the connection
|
||||
s.quit()
|
||||
|
||||
logging.info('Done!')
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
|
|||
5
message.html
Normal file
5
message.html
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
<html>
|
||||
<body>
|
||||
<p>Hello $name, your value is $value!</p>
|
||||
</body>
|
||||
</html>
|
||||
1
requirements.txt
Normal file
1
requirements.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
pandas
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
SUBJECT = ''
|
||||
EMAIL_COLUMN = ''
|
||||
MAIL_COLUMN = ''
|
||||
|
||||
MY_ADDRESS = 'example@domain.tld'
|
||||
PASSWORD = 'p4ssw0rd'
|
||||
|
|
@ -8,3 +8,6 @@ PORT = 587
|
|||
|
||||
WAIT_EVERY = 5
|
||||
DELAY_SEC = 0
|
||||
|
||||
LOGLEVEL = 'INFO'
|
||||
DRY_RUN = True
|
||||
Loading…
Reference in a new issue