Skip to content

Commit

Permalink
Updated Password Instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MinaMatta98 committed Feb 19, 2024
1 parent d2e3f0c commit 2fd774a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

An asynchronous [RUST](https://www.rust-lang.org/) based CLI bulk emailing client, built on top of [lettre-rs](https://github.com/lettre/lettre).

### Features:

### Features
---

|Feature|Description|
|-------|-----------|
Expand All @@ -29,6 +31,7 @@ An asynchronous [RUST](https://www.rust-lang.org/) based CLI bulk emailing clien
<br/>

### Instructions:
---

#### Installation:
Installation of this tool will require [RUST installation version](https://www.rust-lang.org/tools/install) of 1.70 or newer.
Expand All @@ -45,12 +48,13 @@ cargo install --locked --git https://github.com/MinaMatta98/Bulk-Email-Cli-CLien
<br/>

#### Setting Environmental Variables
---
The following environmental variables must be set:

|Variable|Description|
|-------|-----------|
|SENDER_EMAIL|Email of the email account sending the Email(s) |
|SENDER_PASSWORD|Corrosponding password for the email account sending Email(s)|
|SENDER_PASSWORD|Corrosponding password for the email account sending Email(s).Turn on Less-Secure-Apps to send emails: https://myaccount.google.com |
|SMTP_RELAY|The SMTP relay corrosponding to the SMTP Gateway of Choice. For example, Gmail uses smtp.gmail.com and AOL uses smtp.aol.com |

<br/>
Expand All @@ -59,6 +63,7 @@ The following environmental variables must be set:
<br/>

#### Send a Single Email
---
Refer to [Environmental Variables](#environmental-variables) for setting up environmental variables.


Expand Down Expand Up @@ -102,6 +107,7 @@ email-sender single-email --to-addr "[email protected]" --subject "Email Tes
<br/>

#### Send Bulk Emails
---
All three scenarios are listed within their respective order within the following table.

This will corrospond to the following csv file:
Expand Down

0 comments on commit 2fd774a

Please sign in to comment.