Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathieutu/nodemailer-react
A simple but powerfull Nodemailer wrapper to send email with React template.
https://github.com/mathieutu/nodemailer-react
Last synced: about 2 months ago
JSON representation
A simple but powerfull Nodemailer wrapper to send email with React template.
- Host: GitHub
- URL: https://github.com/mathieutu/nodemailer-react
- Owner: mathieutu
- License: mit
- Created: 2019-01-10T08:15:52.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T10:58:11.000Z (almost 3 years ago)
- Last Synced: 2024-11-05T16:57:56.079Z (2 months ago)
- Language: TypeScript
- Size: 307 KB
- Stars: 23
- Watchers: 3
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nodemailer React
This package aims to simplify the use of Nodemailer, along with React templating.
## Installation
```bash
yarn add nodemailer-react
```
This package has `nodemailer`, `react-dom` and `react` as Peer Dependencies,
so you'll need to install them if you don't already have them:
```bash
yarn add nodemailer react-dom react
```
## Usage
You can find a full example in the [example](./example) folder,
or see the [tests](./__tests__) to have more details.
### Configure your SMTP transport
An object that defines your connection data.
See https://nodemailer.com/smtp/#general-options for details.
```js
const transport = {
host: 'smtp.example.com',
secure: true,
auth: { user: 'username', pass: 'password' },
}
```
### Configure your defaults
An object that is going to be merged into every message object.
This allows you to specify shared options, for example to set the same from address for every message.
See https://nodemailer.com/message/#common-fields
```js
const defaults = {
from: "[email protected]",
}
```
### Create Email Components
They are basically functions which can take an object of props in parameter and return an object with :
- The `subject` of the email, as string.
- The `body` of the email, as JSX (ReactElement).
The have the following type:
```ts
type Email = (props: object) => ({
subject: string;
body: ReactElement;
})
```
Example:
```jsx
export const WelcomeEmail = ({ firstName }) => ({
subject: `👋 ${firstName}`,
body: (
Hello {firstName}!
Hope you'll enjoy the package!
)
})
export const PasswordEmail = /* ... */
export const ReminderEmail = /* ... */
```
### Instantiate the `Mailer` function.
It takes your `transport` and `defaults` configuration as the first parameter,
and a record of your emails components as the second.
```js
import { Mailer } from 'nodemailer-react'
export const mailer = Mailer(
{ transport, defaults },
{ WelcomeEmail, PasswordEmail, ReminderEmail }
)
```
_TIP: you can directly pass a transporter from nodemailer's `createTransport` method as first argument if you prefer._
_TIP 2: you can alias your emails easily : `{ welcome: WelcomeEmail, pwd: PasswordEmail, ... }`._
### Enjoy!
Send mails in your application, by passing:
- Your email template name: key of the email in the record you've provided to the Mailer.
- The props of your email component.
- The options of the email (to, from, attachments, etc.).
See https://nodemailer.com/message/#common-fields
```js
mailer.send('WelcomeEmail', { firstName: 'Mathieu' }, {
to: '[email protected]'
})
```
### Typescript
Everything is fully typed, and you should have full autocompletion and type checking,
within the options, but also components and props attached to them in `send` method.
However, as Nodemailer does not publish its own types, be sure to install them from DefinitelyTyped repo:
```bash
yarn add -D @types/nodemailer
```
## License
This nodemailer-react package is an open-sourced software licensed under the MIT license.
## Contributing
Issues and PRs are obviously welcomed and encouraged, both for new features and documentation.