@innovixx/payload-azure-email-adapter
v0.0.3
Published
payload-azure-email-adapter
Downloads
12
Maintainers
Readme
Payload Azure Communication Email Adapter
An email adapter for Payload CMS using Azure Communication Services Email.
Core features:
- Send transactional emails via Azure Communication Services
- Easy integration with Payload's email system
- Supports HTML, plain text, CC, BCC, and reply-to
Installation
yarn add @innovixx/payload-azure-email-adapter
# OR
npm i @innovixx/payload-azure-email-adapterBasic Usage
In your Payload config, set the email property to use the adapter:
import { buildConfig } from 'payload';
import { azureCommunicationEmailAdapter } from '@innovixx/payload-azure-email-adapter';
export default buildConfig({
// ...existing config...
email: azureCommunicationEmailAdapter({
defaultFromAddress: process.env.FROM_EMAIL || '[email protected]',
defaultFromName: 'Innovixx',
connectionString: process.env.AZURE_COMMUNICATION_CONNECTION_STRING,
}),
});Options
The adapter accepts the following options:
defaultFromAddress(string): Default sender email addressdefaultFromName(string): Default sender nameconnectionString(string): Azure Communication Services connection string
TypeScript
Types are available for strict usage:
import type { AzureCommunicationEmailAdapterArgs } from '@innovixx/payload-azure-email-adapter';Development
To develop or debug this adapter, use the included demo directory for a self-seeding Payload instance. Changes in ./src are reflected in the demo. See the demo README for details.
