Automail 0.1.4
sends bulk automated emails
Keywords: Email

[![PyPI version](https://badge.fury.io/py/Automail.svg)](https://badge.fury.io/py/Automail)
[![Downloads](https://img.shields.io/pypi/dm/Automail)](https://pypistats.org/packages/automail)
[![License](https://img.shields.io/pypi/l/Automail)](https://github.com/Preetam2114/Automail/blob/master/LICENSE.txt)
[![Py-versions](https://img.shields.io/pypi/pyversions/Automail)](https://pypi.org/project/Automail)
[![Issues](https://img.shields.io/github/issues/Preetam2114/Automail)](https://github.com/Preetam2114/Automail/issues)

# Automail


Automail is an open source python package to make bulk mailing easy.

The distribution is available on following platforms:
* [Automail on PyPI](https://pypi.org/project/Automail)
* [Automail on Github](https://github.com/Preetam2114/Automail)

## Installation :

```bash
		pip install Automail
```


## Package Functions:

Automail has 2 user function:
1. csv_list(CSV_FILE): This user function generates list of list
		containing maiiling details of the receivers
   - Function arguments:
     - CSV_FILE: points towards the file location
#### usage:	 
```py
		from Automail import csv_list

		myvar = csv_list('location to the csv file')

```
output:
```bash
		Please enter the column name with receiver names: Column name
		Please enter the column name with receiver email-id: Column name
```
2. send_email(subject, body, attachment, receivers): send_email is a stand-alone function 
						which can work without passing any argument	
   - Function Parameter:
     - subject: This argument is responsible for subject of the email.
     - body: 
       - This argument is responsible for the email body the supported formats are marked below.
         - [x] HTML TEMPLATE
         - [x] TEXT
         - [ ] FORMS (NOT TESTED)
       - The body also supports adding name of the receiver use {name} for the places where it's needed.
     - attachment :This argument is responsible for attachment source and supports varities of file formats.
     - receivers : This argument passes the list of list careated using __csv_list__ finction.

#### usage:
```py
		from Automail import send_email,csv_list

		subject = 'This is the email subject'
		body  = 'This is the email body {name}'
		# {name} will automatically get replaced by Name present in CSV file
		attachment = 'location of attachment file'
		receivers = csv_list('location to the csv file')

		send_email(subject, body, attachment, receivers)
```
#### usage:
```bash
		Please enter your email address: xzy@gmail.com
		Please enter your password: .......
```
>NOTE: input for password field won't be displayed while typing for secutity purposes.

# Note:
> In some cases google might restrict login in that case you need to enable Less secure app access [click here](https://myaccount.google.com/lesssecureapps)

## Running test

```bash
pip install -r requirements.txt
pytest -s
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

## Contact
[![twitter][1.1]][1]
[![linkedIn][2.1]][2]
[![github][3.1]][3]

[1.1]: https://www.iconfinder.com/icons/104461/download/png/64
[2.1]: https://www.iconfinder.com/icons/107159/download/png/64
[3.1]: https://www.iconfinder.com/icons/394187/download/png/64

[1]: https://twitter.com/pvr_rane
[2]: https://www.linkedin.com/in/preetam-rane-4b0524165/
[3]: https://github.com/Preetam2114

## Wanna Contribute?

Your contribution is welcome!

Pull Requests will be merged if they match the project requirements.

For prototypes, pure python implementations using ctypes are also welcome.
We will probably port it to a proper extension in the future.

Please ask questions [here](https://github.com/Preetam2114/Automail/issues).