diff --git a/README.md b/README.md index b95ee33..eb9e3c0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # utils +* [sendmail.py](https://git.hmp.today/pavel.muhortov/utils#sendmail.py) +____ +## sendmail.py +| PARAMETERS | DESCRIPTION | DEFAULT| +|-------------|-------------|--------| +|**-u**, **--user**|smtp valid user|**REQUIRED**| +|**-p**, **--pass**|smtp valid password|**REQUIRED**| +|**-d**, **--dest**|destination addresses|**REQUIRED**| +|**[-h]**|print help and exit|| +|**[--smtp]**|smtp hostname or ip address|smtp.gmail.com| +|**[--port]**|smtp port number|587| +|**[--stls]**|smtp required TLS|`True`| +|**[--from]**|mail from alias|**--user** value| +|**[--subj]**|mail subject|'no subject'| +|**[--text]**|mail body text|'no text'| +|**[--type]**|mail body type: plain, html|plain| +|**[--file]**|mail attachment files|`None`| +Example usage in terminal with Python: +```shell +python3 ./sendmail.py -u user@gmail.com -p pass -d addr1@gmail.com,addr2@gmail.com +``` +Example usage in terminal with make the script executable: +```shell +chmod u+x ./sendmail.py +./sendmail.py -u user@gmail.com -p pass -d addr1@gmail.com,addr2@gmail.com +``` +Example usage in Python: +```Python +from sendmail import Mail + +msg = Mail(smtp_user='user@gmail.com', smtp_pass='pass', mail_dest='addr1@gmail.com,addr2@gmail.com') +log = msg.send() +print(log) +``` \ No newline at end of file