README

CI WP-SMTP is a Composer package designed to integrate seamlessly with WordPress sites using the Roots Acorn framework. This package allows you to configure and send emails using a specified SMTP server, ensuring better email deliverability and security for your WordPress site.

Features

• SMTP Configuration: Configure SMTP settings such as server address, port, encryption, and authentication directly from your WordPress admin.
• Acorn Integration: Fully compatible with the Roots Acorn framework, providing a more developer-friendly way to work with WordPress.
• Test Email Functionality: Includes a feature to send test emails to verify SMTP settings.
• Secure: Utilizes WordPress and Acorn best practices for handling sensitive information securely.
• Easy Setup: Simple and straightforward setup process, with support for various SMTP servers including Gmail, Yahoo, SendGrid, and Amazon SES.

Requirements

• WordPress 6.0 or later.
• PHP 8.0 or higher.
• Roots Acorn 4.3 or higher.

Installation

To install CI WP-SMTP in your WordPress project using Roots Acorn, follow these steps:

1. Ensure you have Composer installed and initialized in your WordPress project. If you're using Bedrock, Composer is already set up.

2. Add the CI WP-SMTP package to your project by running the following command in your terminal from your theme directory:

composer require concept-image/wp-smtp

Configuration

After installing CI WP-SMTP, you need to configure it by setting the required SMTP variables in your .env file. This ensures that your SMTP settings are not hard-coded into your project, providing an extra layer of security and making it easier to manage your configuration across different environments.

Add the following lines to your .env file, replacing the placeholder values with your actual SMTP server details:

SMTP_SERVER=your_smtp_server.com
SMTP_USERNAME=your_smtp_username
SMTP_PASSWORD=your_smtp_password
SMTP_FROM=your_email@example.com
SMTP_NAME="Your Name or Your Company"
SMTP_PORT=587
SMTP_SECURE=tls
SMTP_AUTH=true
SMTP_DEBUG=0

Usage

With CI WP-SMTP configured, all outgoing emails from your WordPress site will automatically use the specified SMTP server. You can send a test email from the plugin widget on WordPress dashboard to ensure everything is working correctly. We recommand using ethereal to test your emails.

Changelog

Please refer to CHANGELOG for more information.

Contributing

Please refer to CONTRIBUTING for more information.

License

Please refer to LICENSE for more information.