Collection of utilities for checking email configuration settings.
npm install email-setup
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
will return one of NOT_SETUP
, INVALID
or SETUP
.
const { spfSetup } = require('email-setup');
let isSetup = await spfSetup('foo.com');
hasSPFSender
returns either true
or false
depending on whether the
sender explicitly exists at the top level of the SPF record.
const { hasSPFSender } = require('email-setup');
let isSetup = await hasSPFSender('foo.com', '_spf.google.com');
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
will return one of NOT_SETUP
, INVALID
or SETUP
.
const { hasDKIMRecordForSelector } = require('email-setup');
let isSetup = await hasDKIMRecordForSelector('foo.com', 'google');
hasDKIMRecordForSelector
will return one of NOT_SETUP
, INVALID
or SETUP
.
const { hasDKIMRecordForSelector } = require('email-setup');
let isSetup = await hasDKIMRecordForSelector('foo.com', 'google');
GH_TOKEN=xxx npx semantic-release --no-ci