Email Component
Provisions a transactional email sending service. Deploy in the global region. Functions and authentication components can be granted send access via links.
Configuration Fields
Field | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | required | — | Must be "email" |
name | string | required | — | Unique component name. |
fromAddress | string | optional | — | Default sender address (e.g. noreply@example.com). Must be verified with the provider before use. |
fromName | string | optional | — | Display name for the sender (e.g. My App). |
replyTo | string | optional | — | Reply-to address. |
Cloud Resources Created
- SES Email Identity — verifies the fromAddress domain or address.
- SES Configuration Set — for tracking and suppression list management.
Limitations: New AWS accounts start in SES sandbox mode — you can only send to verified addresses. Request production access via the AWS console. Domain verification requires DNS TXT/DKIM records outside the plugin.
- Azure Communication Services (ACS) Email — email sending resource, provisioned via azure-resourcemanager-communication (global location, Europe data residency). Creation is idempotent.
- Email Domain — Azure-managed domain (azurecomm.net) by default, or a custom domain if fromAddress uses a custom domain.
Limitations: Custom domain verification requires DNS records outside the plugin.
- SendGrid API Key (via Secret Manager) — the plugin stores a SendGrid API key in GCP Secret Manager and grants access to linked functions.
Limitations: Requires a SendGrid account and API key provided as a secret. GCP does not have a native transactional email service.
JSON Example
{
"type": "email",
"name": "transactional-email",
"fromAddress": "noreply@example.com",
"fromName": "My Application",
"replyTo": "support@example.com"
}
References
Email is a target-only component.