https://github.com/lordelogos/clientmail-react-email
@client-mail/react-email is a plugin for client-mail that enables you send email templates built with react-email.
https://github.com/lordelogos/clientmail-react-email
clientmail email-template emailjs react-email resend
Last synced: 5 days ago
JSON representation
@client-mail/react-email is a plugin for client-mail that enables you send email templates built with react-email.
- Host: GitHub
- URL: https://github.com/lordelogos/clientmail-react-email
- Owner: lordelogos
- Created: 2023-08-02T23:44:42.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T08:25:04.000Z (almost 2 years ago)
- Last Synced: 2025-01-08T00:12:55.738Z (4 months ago)
- Topics: clientmail, email-template, emailjs, react-email, resend
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@clientmail/react-email
- Size: 29.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@clientmail/react-email
`@client-mail/react-email` is a plugin for [client-mail](https://github.com/lordelogos/clientmail.js) that enables you send email templates built with [react-email](https://react.email).
## Installation
1. Add `@clientmail/react-email` to your project using your preferred package manager:
With Yarn
```sh
yarn add @clientmail/react-email
```
With Npm
```sh
npm install @clientmail/react-email
```
With Pnpm
```sh
pnpm install @clientmail/react-email
```
2. Add it to the plugins when creating ClientMail class instance
```js
// Add import statement
import { ReactEmailPlugin } from "@clientmail/react-email";
import { ReactEmailTemplate } from "./emails";
// Add to the ClientMail class instance
const clientMail = new ClientMail("rc_A1..", {
reactEmailAdapter: new ReactEmailPlugin(),
});
```
3. Send your react-email templates with `react` option.
```js
const data = {
from: "Acme ",
to: ["[email protected]"],
subject: "Hello World",
// use `react` for react-email templates
react: ,
};
clientMail.resend(data);
```
## Contributing
Contributions to client-mail are welcome! If you find a bug, have suggestions for improvements, or want to add new features, feel free to open an issue or submit a pull request. Please make sure to follow the existing coding style and conventions.
When submitting a pull request, provide a clear description of the changes made and ensure that all tests pass. Adding appropriate tests for new features or bug fixes is highly appreciated.
## Bugs and Feature Requests
For bugs and feature requests, [please create an issue](https://github.com/lordelogos/clientmail-react-email/issues/new/choose).
## Author
- Paul Ehikhuemen ([@pauloe_me](https://twitter.com/pauloe_me))
## License
`@clientmail/react-email` is licensed under the MIT License.