Email

Overview

Project transactional email: templates, test sends, delivery history, lists, and campaign reads against the configured email provider.

API

{pe} = /projects/{projectId}/environments/{environmentId}.

MethodPathNotes
GET/email/healthHealth
GET/POST/email{pe}/templatesRequireAuthorization
PUT/DELETE/email{pe}/templates/{templateId}RequireAuthorization
POST/email{pe}/send-testRequireAuthorization
GET/email{pe}/deliveriesRequireAuthorization
GET/email{pe}/listsRequireAuthorization
GET/email{pe}/campaignsRequireAuthorization

Clients

PackageRuntime
@vijihub/emailserver
VijiHub.Email.NET

Implementation

  1. Enable Email and configure a provider (Smtp, Postmark, Mailgun, SendGrid, Resend, AwsSes, or logging in Development).
  2. Create templates, send tests, and monitor deliveries.
  3. Platform auth emails (confirm/reset) are separate Identity flows handled by the platform email path in Development.

Constraints

  • Project email APIs require authorization (JWT).
  • Provider credentials stay in environment settings.
  • Respect provider sending limits and domain authentication (SPF/DKIM) outside VijiHub.