roots / acorn-mail
Simple WordPress SMTP using Acorn's mail configuration.
Fund package maintenance!
roots
Installs: 1 482
Dependents: 0
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 2
Open Issues: 3
Type:package
Requires
- php: >=8.1
Requires (Dev)
- laravel/pint: ^1.13
- roots/acorn: ^4.0
README
Acorn Mail is a simple package handling WordPress SMTP using Acorn's mail configuration.
Requirements
Installation
Install via Composer:
$ composer require roots/acorn-mail
Getting Started
Start by optionally publishing Acorn's mail config:
$ wp acorn mail:config
SMTP credentials can be found in the published mail.php
config file and default to environment variables.
Usage
For most configurations, you can simply set the following variables in your environment:
MAIL_HOST= MAIL_PORT= MAIL_USERNAME= MAIL_PASSWORD= MAIL_FROM_ADDRESS= MAIL_FROM_NAME=
If you need to change the default encryption from tls
, you can set the encryption variable:
MAIL_ENCRYPTION=ssl
Once the credentials are properly configured, you can send a test email using Acorn's CLI:
$ wp acorn mail:test [--to=]
If any errors are detected, they will be printed to console.
Bug Reports
If you discover a bug in Acorn Mail, please open an issue.
Contributing
Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.
License
Acorn Mail is provided under the MIT License.