Skip to content

Commit f899311

Browse files
committed
Remove account-specific IDs and simplify config docs
Remove hardcoded account ID, inbox ID, and domain ID from test plan and documentation. Simplify configuration to only require api-token (account-id is no longer needed).
1 parent a4178f9 commit f899311

2 files changed

Lines changed: 12 additions & 19 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,22 @@ make build
3030

3131
## Configuration
3232

33-
Set your API token and account ID:
33+
Set your API token:
3434

3535
```bash
3636
mailtrap configure --api-token YOUR_TOKEN
3737
```
3838

39-
Or use environment variables:
39+
Or set an environment variable:
4040

4141
```bash
4242
export MAILTRAP_API_TOKEN=your-token
43-
export MAILTRAP_ACCOUNT_ID=your-account-id
4443
```
4544

4645
Or create `~/.mailtrap.yaml`:
4746

4847
```yaml
4948
api-token: your-token
50-
account-id: "your-account-id"
5149
```
5250
5351
## Usage

docs/TEST_PLAN.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,22 @@ Tests read credentials from `~/.mailtrap.yaml`:
1212

1313
```yaml
1414
api-token: <your-mailtrap-api-token>
15-
account-id: "<your-account-id>"
1615
```
1716
1817
The `.mailtrap.yaml` file is in `.gitignore` — **never commit credentials**.
1918

20-
You can also set environment variables instead:
19+
You can also set an environment variable instead:
2120
```bash
2221
export MAILTRAP_API_TOKEN=your-token
23-
export MAILTRAP_ACCOUNT_ID=your-account-id
2422
```
2523

2624
### 2. Sandbox Setup
2725

2826
Before running integration tests, ensure you have:
2927
- A Mailtrap account with API access
3028
- At least one **sandbox project** with an **inbox**
31-
- Note down the **inbox ID** for sandbox send tests
32-
33-
The test account used during development:
34-
- Account ID: `<YOUR_ACCOUNT_ID>`
35-
- Test inbox: `mailtrap-cli` (ID: `<YOUR_INBOX_ID>`)
29+
- Note down your **inbox ID** for sandbox send tests
30+
- A verified **sending domain** for transactional/bulk send tests
3631

3732
### 3. Build the CLI
3833

@@ -170,17 +165,17 @@ Prerequisite: Send an email with an attachment to the sandbox inbox.
170165

171166
## 7. Email Sending (Transactional/Bulk)
172167

173-
**Note:** Requires a verified sending domain. Use `yourdomain.com` (domain ID: <DOMAIN_ID>).
168+
**Note:** Requires a verified sending domain.
174169

175170
| # | Test | Command | Expected |
176171
|---|------|---------|----------|
177-
| 7.1 | Send transactional | `mailtrap send transactional --from demo@yourdomain.com --to recipient@example.com --subject "CLI Test" --text "Hello"` | Success with message IDs |
178-
| 7.2 | Send bulk | `mailtrap send bulk --from demo@yourdomain.com --to recipient@example.com --subject "Bulk CLI Test" --text "Hello"` | Success |
179-
| 7.3 | Send with named from | `mailtrap send transactional --from "CLI Test <demo@yourdomain.com>" --to recipient@example.com --subject "Named" --text "Hi"` | Success, `from.name` populated |
180-
| 7.4 | Batch transactional | `mailtrap send batch-transactional --from demo@yourdomain.com --to recipient@example.com --subject "Batch" --text "Hi"` | Success |
181-
| 7.5 | Batch bulk | `mailtrap send batch-bulk --from demo@yourdomain.com --to recipient@example.com --subject "Batch Bulk" --text "Hi"` | Success |
172+
| 7.1 | Send transactional | `mailtrap send transactional --from you@yourdomain.com --to recipient@example.com --subject "CLI Test" --text "Hello"` | Success with message IDs |
173+
| 7.2 | Send bulk | `mailtrap send bulk --from you@yourdomain.com --to recipient@example.com --subject "Bulk CLI Test" --text "Hello"` | Success |
174+
| 7.3 | Send with named from | `mailtrap send transactional --from "CLI Test <you@yourdomain.com>" --to recipient@example.com --subject "Named" --text "Hi"` | Success, `from.name` populated |
175+
| 7.4 | Batch transactional | `mailtrap send batch-transactional --from you@yourdomain.com --to recipient@example.com --subject "Batch" --text "Hi"` | Success |
176+
| 7.5 | Batch bulk | `mailtrap send batch-bulk --from you@yourdomain.com --to recipient@example.com --subject "Batch Bulk" --text "Hi"` | Success |
182177
| 7.6 | Missing flags | `mailtrap send transactional` | Error: required flags |
183-
| 7.7 | JSON output | `mailtrap send transactional --from demo@yourdomain.com --to recipient@example.com --subject "JSON" --text "Hi" --output json` | Valid JSON |
178+
| 7.7 | JSON output | `mailtrap send transactional --from you@yourdomain.com --to recipient@example.com --subject "JSON" --text "Hi" --output json` | Valid JSON |
184179

185180
## 8. Domains (Sending)
186181

0 commit comments

Comments
 (0)