@astralibx/email-account-manager 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -26
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -66,17 +66,17 @@ app.listen(3000);
|
|
|
66
66
|
|
|
67
67
|
## Features
|
|
68
68
|
|
|
69
|
-
- **Multi-account management** -- Gmail and AWS SES providers with credential storage and status tracking. [Details](docs/account-management.md)
|
|
70
|
-
- **Health tracking** -- Automatic scoring (+1/-5/-10) with auto-disable on threshold breach. [Details](docs/health-tracking.md)
|
|
71
|
-
- **Account warmup** -- Phased volume ramp-up with configurable schedules stored per-account. [Details](docs/warmup-system.md)
|
|
72
|
-
- **Capacity-based rotation** -- Health-weighted account selection with daily limit enforcement. [Details](docs/capacity-selection.md)
|
|
73
|
-
- **Reliable sending** -- BullMQ queues with retries, dev mode redirect, and per-account SMTP. [Details](docs/email-sending.md)
|
|
74
|
-
- **Draft approval workflow** -- Create, review, approve/reject, bulk operations, send window spread. [Details](docs/draft-approval.md)
|
|
75
|
-
- **Unsubscribe handling** -- HMAC tokens, styled confirmation page, RFC 8058 one-click support. [Details](docs/unsubscribe.md)
|
|
76
|
-
- **SES webhooks** -- SNS signature verification, bounce/complaint/delivery/open/click processing. [Details](docs/ses-webhooks.md)
|
|
77
|
-
- **IMAP bounce detection** -- Gmail IMAP polling with bounce classification. [Details](docs/imap-bounce-checking.md)
|
|
78
|
-
- **Global settings** -- Runtime-adjustable config stored in MongoDB with in-memory caching. [Details](docs/global-settings.md)
|
|
79
|
-
- **Error classes** -- Typed errors with codes for every failure scenario. [Details](docs/error-handling.md)
|
|
69
|
+
- **Multi-account management** -- Gmail and AWS SES providers with credential storage and status tracking. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/account-management.md)
|
|
70
|
+
- **Health tracking** -- Automatic scoring (+1/-5/-10) with auto-disable on threshold breach. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/health-tracking.md)
|
|
71
|
+
- **Account warmup** -- Phased volume ramp-up with configurable schedules stored per-account. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/warmup-system.md)
|
|
72
|
+
- **Capacity-based rotation** -- Health-weighted account selection with daily limit enforcement. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/capacity-selection.md)
|
|
73
|
+
- **Reliable sending** -- BullMQ queues with retries, dev mode redirect, and per-account SMTP. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/email-sending.md)
|
|
74
|
+
- **Draft approval workflow** -- Create, review, approve/reject, bulk operations, send window spread. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/draft-approval.md)
|
|
75
|
+
- **Unsubscribe handling** -- HMAC tokens, styled confirmation page, RFC 8058 one-click support. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/unsubscribe.md)
|
|
76
|
+
- **SES webhooks** -- SNS signature verification, bounce/complaint/delivery/open/click processing. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/ses-webhooks.md)
|
|
77
|
+
- **IMAP bounce detection** -- Gmail IMAP polling with bounce classification. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/imap-bounce-checking.md)
|
|
78
|
+
- **Global settings** -- Runtime-adjustable config stored in MongoDB with in-memory caching. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/global-settings.md)
|
|
79
|
+
- **Error classes** -- Typed errors with codes for every failure scenario. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/error-handling.md)
|
|
80
80
|
|
|
81
81
|
## Architecture
|
|
82
82
|
|
|
@@ -88,26 +88,26 @@ The library exposes three Express routers from a single factory call:
|
|
|
88
88
|
| `eam.webhookRoutes.ses` | SES/SNS event receiver | Public (SNS signature verified) |
|
|
89
89
|
| `eam.unsubscribeRoutes` | Unsubscribe confirmation pages | Public |
|
|
90
90
|
|
|
91
|
-
All services are also available programmatically via the returned `eam` object. See [Programmatic API](docs/programmatic-api.md).
|
|
91
|
+
All services are also available programmatically via the returned `eam` object. See [Programmatic API](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/programmatic-api.md).
|
|
92
92
|
|
|
93
93
|
## Documentation
|
|
94
94
|
|
|
95
95
|
| Document | Description |
|
|
96
96
|
|----------|-------------|
|
|
97
|
-
| [Configuration](docs/configuration.md) | Full config reference -- db, redis, ses, unsubscribe, options, hooks, logger |
|
|
98
|
-
| [Account Management](docs/account-management.md) | Adding accounts, providers (Gmail/SES), status lifecycle |
|
|
99
|
-
| [Health Tracking](docs/health-tracking.md) | Scoring rules, auto-disable triggers, thresholds |
|
|
100
|
-
| [Warmup System](docs/warmup-system.md) | Phases, daily limits, progression, DB-driven schedules |
|
|
101
|
-
| [Capacity Selection](docs/capacity-selection.md) | Best account selection, rotation algorithm |
|
|
102
|
-
| [Email Sending](docs/email-sending.md) | SMTP service, BullMQ queues, dev mode redirect |
|
|
103
|
-
| [Draft & Approval](docs/draft-approval.md) | Creating drafts, approval workflow, bulk operations, send window |
|
|
104
|
-
| [Unsubscribe](docs/unsubscribe.md) | HMAC tokens, confirmation page, one-click, RFC 8058 |
|
|
105
|
-
| [SES Webhooks](docs/ses-webhooks.md) | SNS setup, signature verification, event processing |
|
|
106
|
-
| [IMAP Bounce Checking](docs/imap-bounce-checking.md) | Gmail IMAP polling, bounce classification |
|
|
107
|
-
| [Global Settings](docs/global-settings.md) | Runtime settings, sections, caching, defaults |
|
|
108
|
-
| [API Routes](docs/api-routes.md) | All 3 routers with endpoint tables |
|
|
109
|
-
| [Programmatic API](docs/programmatic-api.md) | Using services directly via the EmailAccountManager interface |
|
|
110
|
-
| [Error Handling](docs/error-handling.md) | All error classes with codes |
|
|
97
|
+
| [Configuration](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/configuration.md) | Full config reference -- db, redis, ses, unsubscribe, options, hooks, logger |
|
|
98
|
+
| [Account Management](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/account-management.md) | Adding accounts, providers (Gmail/SES), status lifecycle |
|
|
99
|
+
| [Health Tracking](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/health-tracking.md) | Scoring rules, auto-disable triggers, thresholds |
|
|
100
|
+
| [Warmup System](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/warmup-system.md) | Phases, daily limits, progression, DB-driven schedules |
|
|
101
|
+
| [Capacity Selection](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/capacity-selection.md) | Best account selection, rotation algorithm |
|
|
102
|
+
| [Email Sending](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/email-sending.md) | SMTP service, BullMQ queues, dev mode redirect |
|
|
103
|
+
| [Draft & Approval](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/draft-approval.md) | Creating drafts, approval workflow, bulk operations, send window |
|
|
104
|
+
| [Unsubscribe](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/unsubscribe.md) | HMAC tokens, confirmation page, one-click, RFC 8058 |
|
|
105
|
+
| [SES Webhooks](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/ses-webhooks.md) | SNS setup, signature verification, event processing |
|
|
106
|
+
| [IMAP Bounce Checking](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/imap-bounce-checking.md) | Gmail IMAP polling, bounce classification |
|
|
107
|
+
| [Global Settings](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/global-settings.md) | Runtime settings, sections, caching, defaults |
|
|
108
|
+
| [API Routes](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/api-routes.md) | All 3 routers with endpoint tables |
|
|
109
|
+
| [Programmatic API](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/programmatic-api.md) | Using services directly via the EmailAccountManager interface |
|
|
110
|
+
| [Error Handling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-account-manager/docs/error-handling.md) | All error classes with codes |
|
|
111
111
|
|
|
112
112
|
## Security Notes
|
|
113
113
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astralibx/email-account-manager",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "Reusable email account management with Gmail + SES support, BullMQ queues, health tracking, warmup, and optional approval workflow",
|
|
5
5
|
"main": "dist/index.cjs",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -27,7 +27,6 @@
|
|
|
27
27
|
"test:watch": "vitest",
|
|
28
28
|
"test:coverage": "vitest run --coverage",
|
|
29
29
|
"lint": "eslint src/",
|
|
30
|
-
|
|
31
30
|
"clean": "rm -rf dist"
|
|
32
31
|
},
|
|
33
32
|
"keywords": [
|