The `parse-server-api-mail-adapter` provides a universal email solution for Parse Server, enabling it to send emails via any third-party REST API. It supports dynamic templates, localization, and includes out-of-the-box integrations for services like AWS SES, Mailgun, and ZeptoMail, along with a custom API option. The current stable version is 5.0.5, with frequent maintenance releases for security updates and occasional minor/major releases for new features or Node.js version support. Its key differentiators include its extensibility to any REST API-based mail service, built-in templating, and full localization support, making it a flexible choice compared to adapters tied to specific providers. It ships with TypeScript definitions, enhancing developer experience for TypeScript users.
npm install parse-server-api-mail-adapterVerified import paths — ran on the pinned version, not inferred.
Demonstrates how to configure `parse-server-api-mail-adapter` with Parse Server using environment variables for sensitive data and Mailgun as an example provider, including template paths.
Upgrade your Node.js runtime to version 20, 22, or 24. Update your `package.json` engines field accordingly and re-install dependencies.
Upgrade your Node.js runtime to version 18, 20, or 22 (for v4.x.x). For v5.x.x, Node.js 20, 22, or 24 is required.
Update any direct GitHub links, git remotes, or package manager references (if directly pointing to the old repo) to `parse-community/parse-server-api-mail-adapter`.
Regularly update to the latest patch version (e.g., `npm install parse-server-api-mail-adapter@latest`) to ensure all known security patches for dependencies are applied.
Review the 'Custom API' section in the documentation. Implement the `send` function to accept `mail` and `options` objects and return a Promise that resolves upon successful sending.
Upgrade your Node.js environment to version 20, 22, or 24. For example, using NVM: `nvm install 20 && nvm use 20`.
Ensure `mailgun.js` or your chosen mail client is correctly imported, initialized with necessary API keys, and the resulting client instance is passed to the adapter configuration under `options.api.[providerName].client`.
Verify that the template files exist at the exact paths specified in the `templates` object within the `emailAdapter` configuration. Ensure file permissions allow the Parse Server process to read them.
Double-check your `MAILGUN_API_KEY` and `MAILGUN_DOMAIN` environment variables or hardcoded values in the adapter configuration against your Mailgun account details.