https://github.com/brandonxlf/email-auth
Configure the DKIM selector, SPF, DMARC, bounce address, from address, and reply-to address of emails sent by WordPress.
https://github.com/brandonxlf/email-auth
dkim dmarc email email-authentication spf wordpress wordpress-plugin
Last synced: about 1 month ago
JSON representation
Configure the DKIM selector, SPF, DMARC, bounce address, from address, and reply-to address of emails sent by WordPress.
- Host: GitHub
- URL: https://github.com/brandonxlf/email-auth
- Owner: BrandonXLF
- License: gpl-2.0
- Created: 2025-01-16T03:51:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-23T08:48:19.000Z (over 1 year ago)
- Last Synced: 2025-01-23T09:31:01.154Z (over 1 year ago)
- Topics: dkim, dmarc, email, email-authentication, spf, wordpress, wordpress-plugin
- Language: PHP
- Homepage: https://www.brandonfowler.me/email-auth/
- Size: 250 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Email Auth - DKIM, SPF, DMARC, Bounce Address, From Address
**Configure the DKIM selector, SPF, DMARC, bounce address, from address, and reply-to address of emails sent by WordPress.**
## Description
Email Auth allows you to enable email authentication/validation for your WordPress site. Configure the DKIM selector, SPF, DMARC, bounce address, from address, and reply-to address of emails sent by WordPress through the default PHPMailer.
Configuring these email settings allows you to prevent attackers from spoofing emails from your domain and helps keep your emails out of the spam folder.
### DKIM Selector
Create, upload, download, and delete private and public keys for use with DKIM with an intuitive interface.
Configure emails to use a DKIM selector and configure which domain should be used with DKIM.
### SPF
Create a new SPF record for your envelope domain, validate an existing record, or view recommendations for how to improve your SPF configuration.
### DMARC
Validate your DMARC DNS record settings and view comments about your current configuration.
### Bounce Address
Set your bounce address to ensure emails are being sent from the right domain to avoid having your emails rejected or marked as spam.
### From Address and Reply-To Address
Set the address and name emails are sent from along with the address replies should be sent to.
## Installation
### Requirements
* WordPress 4.6 or newer
* PHP 7.0 or greater is required (PHP 8.0 or greater is recommended)
### Steps
1. Upload this folder to your plugin directory (`wp-content/plugins`)
2. Activate the plugin through the "Plugins" menu in WordPress
3. Visit "Settings" > "Email Auth" to configure the plugin
## Developing
### Installing dependencies
Composer and npm are required to install dependencies. Once they are installed, run `composer install` and `npm install` to install dependencies.
### Running tests
To run integration tests, an installation of WordPress is required to be installed with `bin/install-wp-tests.sh`. This script requires Subversion to be installed. Once installed, run `composer run test` to run tests. You can also run unit tests, which do not depend on a WordPress installation, using `composer run test:unit`.
Once Composer dependencies are installed, run `composer run test` to run tests.
### Code sniffing
#### PHP
Run `composer run phpcs` to run the code sniffer. Run `composer run phpcs:full` for a full breakdown of what errors occurred and `composer run phpcs:fix` to fix any auto-fixable errors.
#### JS
Run `npm run lint` to run the linter and `npm run lint:fix` to fix any auto-fixable errors.
### Creating ZIP archive
Run `bin/build-zip.sh` to create a ZIP archive of the plugin that is suitable to be uploaded to a WordPress site.
### Publishing
Run `bin/release-svn.sh` to create a release version and add it as a tag to SVN. Run `bin/update-svn-assets.sh` to update wordpress.org assets only. You can specify your SVN username with `--username USERNAME`.