https://github.com/mixmaxhq/email-setup
Collection of utilities for checking email configuration settings.
https://github.com/mixmaxhq/email-setup
corgi-tag
Last synced: 18 days ago
JSON representation
Collection of utilities for checking email configuration settings.
- Host: GitHub
- URL: https://github.com/mixmaxhq/email-setup
- Owner: mixmaxhq
- License: mit
- Created: 2017-08-18T15:22:16.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-20T18:50:56.000Z (over 1 year ago)
- Last Synced: 2024-10-15T15:45:15.302Z (7 months ago)
- Topics: corgi-tag
- Language: JavaScript
- Homepage: https://www.mixmax.com/careers
- Size: 604 KB
- Stars: 2
- Watchers: 24
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# email-setup
Collection of utilities for checking email configuration settings.
## Installation
```sh
npm install email-setup
```
## Usage
### SPF
SPF records exist as `TXT` records on a sending domain itself. `spfSetup` allows
us to determine if a domain has a valid SPF record, and `hasSPFSender` allows us
to detemine if a specific sender is allowed to send for the given domain. Note
that `hasSPFSender` currently only support top level `include` detection, it
does not currently resolve the SPF record to determine inclusion at a deeper
level than the top level nor does it support IP based domain resolution querying
at the moment.
#### spfSetup
`spfSetup` will return one of `NOT_SETUP`, `INVALID` or `SETUP`.
```js
const { spfSetup } = require('email-setup');
let isSetup = await spfSetup('foo.com');
```
#### hasSPFSender
`hasSPFSender` returns either `true` or `false` depending on whether the
sender explicitly exists at the top level of the SPF record.
```js
const { hasSPFSender } = require('email-setup');
let isSetup = await hasSPFSender('foo.com', '_spf.google.com');
```
### DKIM
DKIM records do not exist at any predetermined location, as such to check if
a DKIM record is setup for a given system, we need to know the selector to look
for the record under. Once we know that, we can determine whether a DKIM key
has been setup for the given domain at the given selector.
#### hasDKIMRecordForSelector
`hasDKIMRecordForSelector` will return one of `NOT_SETUP`, `INVALID` or `SETUP`.
```js
const { hasDKIMRecordForSelector } = require('email-setup');
let isSetup = await hasDKIMRecordForSelector('foo.com', 'google');
```
### DMARC
#### dmarcSetup
`hasDKIMRecordForSelector` will return one of `NOT_SETUP`, `INVALID` or `SETUP`.
```js
const { hasDKIMRecordForSelector } = require('email-setup');
let isSetup = await hasDKIMRecordForSelector('foo.com', 'google');
```
## Publishing a new version
```
GH_TOKEN=xxx npx semantic-release --no-ci
```