Skip to content

Commit

Permalink
Extend readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaminshafii authored and BlankParticle committed Aug 30, 2024
1 parent 2b606d7 commit 7b69327
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions packages/scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@
To send emails using the script, run the following command:

```sh

pnpm stress:email email=some@**gmail**.com amount=100 [interval=60] [mode=individual|reply-chain]

```

- `email`: The recipient's email address.
- `amount`: Number of emails to send.
- `interval` (optional): Time in seconds between emails. Default is 60.
- `mode` (optional): `individual` or `reply-chain`. Default is `individual`.

**Note:** This script assumes a `.env.test.local` file exists with the following values as specified in `env.ts`:

```
MAILBRIDGE_TRANSACTIONAL_CREDENTIALS={"apiUrl":"https://example.com","apiKey":"your-api-key","sendAsName":"Sender Name","sendAsEmail":"sender@example.com"}
```

---

## Example
Expand Down

0 comments on commit 7b69327

Please sign in to comment.