{"id":17609913,"url":"https://github.com/vixalien/payload-email-azure","last_synced_at":"2026-01-02T01:30:05.211Z","repository":{"id":246082509,"uuid":"820076556","full_name":"vixalien/payload-email-azure","owner":"vixalien","description":"Payload email adapter for azure","archived":false,"fork":false,"pushed_at":"2024-09-10T10:31:43.000Z","size":80,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T22:05:41.678Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vixalien.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-25T18:46:01.000Z","updated_at":"2024-09-10T10:32:39.000Z","dependencies_parsed_at":"2024-06-25T19:33:42.084Z","dependency_job_id":"d993354b-bb4a-4af2-892a-f35892e325bb","html_url":"https://github.com/vixalien/payload-email-azure","commit_stats":null,"previous_names":["vixalien/payload-email-azure"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vixalien%2Fpayload-email-azure","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vixalien%2Fpayload-email-azure/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vixalien%2Fpayload-email-azure/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vixalien%2Fpayload-email-azure/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vixalien","download_url":"https://codeload.github.com/vixalien/payload-email-azure/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242661652,"owners_count":20165329,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-22T17:24:07.562Z","updated_at":"2026-01-02T01:30:05.162Z","avatar_url":"https://github.com/vixalien.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Azure Email Communication Services Adapter\n\nThis adapter allows you to send emails using\n[Azure Email Communication Services](https://learn.microsoft.com/en-us/azure/communication-services/concepts/email/email-overview)\n\n## Installation\n\n```sh\npnpm add payload-email-azure\n```\n\n## Prerequesites\n\n1. [An Azure account with an active subscription](https://azure.microsoft.com/free/).\n2. [An Azure Email Communication Services resource created and ready with a provisioned domain](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/email/create-email-communication-resource).\n3. [An active Azure Communication Services resource connected to an Email Domain and its connection string. Get started by connecting an Email Communication Resource with a Azure Communication Resource](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource)\n\n```ts\nimport { azureEmailAdapter } from \"payload-email-azure\";\n\nexport default buildConfig({\n  email: azureEmailAdapter({\n    defaultFromAddress: \"DoNotReply@notify.example.com\",\n    connectionString: process.env.AZURE_EMAIL_CONNECTION_STRING,\n  }),\n});\n```\n\n\u003e Note: The `defaultFromAddress` must match one of the pre-configured\n\u003e `EmailFrom` addresses in your Azure Communication Service resource.\n\n## Authentication\n\nThere are a few different options available for authenticating an email client\nwith Azure.\n\n### Using Connection String\n\n```ts\nimport { azureEmailAdapter } from \"payload-email-azure\";\n\nexport default buildConfig({\n  email: azureEmailAdapter({\n    defaultFromAddress: \"noreply@notify.example.com\",\n    connectionString: process.env.AZURE_EMAIL_CONNECTION_STRING,\n  }),\n});\n```\n\n### Using Microsoft Entra ID\n\nYou may also choose to authenticate with Microsoft Entra ID using the\n`@azure/identity` package.\n\n```ts\nimport { azureEmailAdapter } from \"payload-email-azure\";\nimport { DefaultAzureCredential } from \"@azure/identity\";\n\nexport default buildConfig({\n  email: azureEmailAdapter({\n    defaultFromAddress: \"noreply@notify.example.com\",\n    endpoint: process.env.AZURE_EMAIL_ENDPOINT,\n    // The DefaultAzureCredential uses the following environment variables:\n    // AZURE_CLIENT_SECRET, AZURE_CLIENT_ID and AZURE_TENANT_ID\n    credential: new DefaultAzureCredential(),\n  }),\n});\n```\n\n### Using Azure Key Credentials\n\nYou can also choose to authenticate the email client using an\nAzureKeyCredential. Both the `key` and the `endpoint` can be founded on the\n\"Keys\" pane under \"Settings\" in your Communication Services Resource.\n\n```ts\nimport { azureEmailAdapter } from \"payload-email-azure\";\nimport { AzureKeyCredential } from \"@azure/core-auth\";\n\nexport default buildConfig({\n  email: azureEmailAdapter({\n    defaultFromAddress: \"noreply@notify.example.com\",\n    endpoint: process.env.AZURE_EMAIL_ENDPOINT,\n    credential: new AzureKeyCredential(process.env.AZURE_EMAIL_KEY),\n  }),\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvixalien%2Fpayload-email-azure","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvixalien%2Fpayload-email-azure","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvixalien%2Fpayload-email-azure/lists"}