Name	Last modified	Size	Description
	Parent Directory		-
	dist/	2023-06-15 18:18	-
	README.md	1985-10-26 08:15	3.3K	d7c1522 post receive test [كارل مبارك]
	package.json	2023-06-15 18:21	2.3K
	LICENSE	1985-10-26 08:15	1.4K

# @strapi/provider-email-sendmail

## Resources

- [LICENSE](LICENSE)

## Links

- [Strapi website](https://strapi.io/)
- [Strapi documentation](https://docs.strapi.io)
- [Strapi community on Discord](https://discord.strapi.io)
- [Strapi news on Twitter](https://twitter.com/strapijs)

## Installation

```bash
# using yarn
yarn add @strapi/provider-email-sendmail

# using npm
npm install @strapi/provider-email-sendmail --save
```

## Configuration

| Variable                | Type              | Description                                                                                                              | Required | Default   |
| ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------ | -------- | --------- |
| provider                | string            | The name of the provider you use                                                                                         | yes      |           |
| providerOptions         | object            | Will be directly given to `require('sendmail')`. Please refer to [sendmail](https://www.npmjs.com/package/sendmail) doc. | no       | {}        |
| settings                | object            | Settings                                                                                                                 | no       | {}        |
| settings.defaultFrom    | string            | Default sender mail address                                                                                              | no       | undefined |
| settings.defaultReplyTo | string \| array   | Default address or addresses the receiver is asked to reply to                                                           | no       | undefined |
| providerOptions.dkim    | object \| boolean | DKIM parameters having two properties: { privateKey, keySelector }                                                       | no       | false     |

> :warning: The Shipper Email (or defaultfrom) may also need to be changed in the `Email Templates` tab on the admin panel for emails to send properly

### Example

**Path -** `config/plugins.js`

```js
module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      provider: 'sendmail',
      settings: {
        defaultFrom: 'myemail@protonmail.com',
        defaultReplyTo: 'myemail@protonmail.com',
      },
    },
  },
  // ...
});
```

### Example with DKIM

Using **DKIM** (DomainKeys Identified Mail) can prevent emails from being considered as spam. More details about this subject can be found in the discussion on the Strapi forum: [Unsolved problem: emails goes to spam!](https://forum.strapi.io/t/unsolved-problem-emails-goes-to-spam/512?u=soringfs)

#### Generate the keys using OpenSSL

```perl
openssl genrsa -out dkim-private.pem 1024
openssl rsa -in dkim-private.pem -pubout -out dkim-public.pem
```

**Path -** `config/plugins.js`

```js
module.exports = ({ env }) => ({
  // ...
  email: {
    provider: 'sendmail',
    providerOptions: {
      dkim: {
        privateKey: 'replace-with-dkim-private-key',
        keySelector: 'abcd', // the same as the one set in DNS txt record, use online dns lookup tools to be sure that is retreivable
      },
    },
    settings: {
      defaultFrom: 'myemail@protonmail.com',
      defaultReplyTo: 'myemail@protonmail.com',
    },
  },
  // ...
});
```