Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md is updated #24

Merged
merged 1 commit into from
Aug 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 65 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# PyAutoMail: A Python package and command-line interface for automation sending email to your contact list


<p align="center" width="100%">
<p style="text-align: center">
<img width="80%" src="https://github.com/msinamsina/automail/blob/main/docs/_static/automail-logo.png?raw=true" >
</p>

Expand All @@ -20,20 +20,69 @@ Revolutionize your email operations, whether it involves mass email distribution
pip install pyautomail
```

### Github
### [Github](https://github.com/msinamsina/pyautomail.git)
```bash
pip install git+https://github.com/msinamsina/automail.git
pip install git+https://github.com/msinamsina/pyautomail.git
```

## How to use in command-line interface
At first, you should register your email address and contact list
```bash
automail register <your-email-address> <Path-to-your-contact-list> [options]
```
Then you can send email to your contact list
```bash
automail start <process-id>
```

1. At first, you should initialize project
```bash
pyhhon -m automail init
```

After running this command, you will see a some questions. You should answer them.

```bash
Where do you want to initialize the automail project? [./automail-workspace]
What is your smtp server? [smtp.gmail.com]:
What is your smtp port? [465]:
```

**📘 Note:**
1. This command will create a folder with the project name in the path you specified.
If you don't specify the path, it will create ```automail-workspace```.
2. You can change the default smtp server by default it has been set on **Gmail Smtp Server**.
3. You also can set the port of **Smtm Server** (by default 465).
4. Additionally, if you want to save you password in config file, you can use the ```-p``` or
```--pasword``` switch.
5. Moreover, if you want to initialize a test project, you can use ```-t``` or ```--test```.
```bash
$ pyhhon -m automail init -t -p <your-password>
```

> **[📙 Important]()**
> If directory already exists, it will be overwritten.

1. Then you should go to the project directory and register your contact list
```bash
cd <your-project-name>
pyhhon -m automail register <Path-to-your-contact-list> [options]
```
**📘 Note:**
For using a template, use ```--template``` switch. The template can be ```.txt``` or ```.html```
Format.
```bash
pyhhon -m automail register contact-list.csv --template ./body.html
```
**body.html:**
```html
<h1> Hi {{ name }}, </h1>
```
**contact-list.csv:**
```csv
email,name,data1,cpdf
contact1@gmail.com,contact1,ali,/path/to/pdf1
contact2@gmail.com,contact2,mohammad,/path/to/pdf2
contact3@gmail.com,contact3,soheila,/path/to/pdf3
```

1. Now you can start sending emails by running the following command
```bash
pyhhon -m automail start <process-id>
```

## How to use in python
```python
from automail import EmailSender
Expand All @@ -45,12 +94,12 @@ automail start <process-id>

### Documentation and Resources

For more comprehensive information about **PyAutoMail** and its capabilities, please explore our detailed [documentation](https://automail.readthedocs.io/en/latest/).
For more comprehensive information about **PyAutoMail** and its capabilities, please explore our detailed [documentation](https://pyautomail.readthedocs.io/en/latest/).

- Get a brief overview and explore the features of PyAutoMail in the [Introduction](https://automail.readthedocs.io/en/latest/introduction.html) section.
- If you're new to PyAutoMail, follow our [Getting Started](https://automail.readthedocs.io/en/latest/getting-started.html) guide to kickstart your email automation journey.
- For a quick reference, you can check out the [API Reference](https://automail.readthedocs.io/en/latest/api/index.html) section.
- To gain deeper insights into PyAutoMail and learn best practices, dive into our informative [Tutorial](https://automail.readthedocs.io/en/latest/tutorial/index.html) section.
- Get a brief overview and explore the features of PyAutoMail in the [Introduction](https://pyautomail.readthedocs.io/en/latest/introduction.html) section.
- If you're new to PyAutoMail, follow our [Getting Started](https://pyautomail.readthedocs.io/en/latest/getting-started.html) guide to kickstart your email automation journey.
- For a quick reference, you can check out the [API Reference](https://pyautomail.readthedocs.io/en/latest/api/index.html) section.
- To gain deeper insights into PyAutoMail and learn best practices, dive into our informative [Tutorial](https://pyautomail.readthedocs.io/en/latest/tutorial/index.html) section.

By exploring these resources, you'll harness the full potential of PyAutoMail and make the most out of its powerful email automation capabilities.

Expand Down