wp-blueprint/plugin-mailer

Lightweight WP Blueprint plugin that provides a reusable and straightforward approach to managing SMTP settings and improves email sending functionality within WordPress.

dev-main 2023-10-23 08:25 UTC

Requires

• php: >=5.6

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
• php-parallel-lint/php-parallel-lint: ^1.2.0
• wp-cli/i18n-command: ^2.2.5
• wptrt/wpthemereview: ^0.2.1

GPL-3.0-or-later

• Yanis Deplazes

README

This plugin provides an easy-to-use settings page where you can configure your SMTP host, authentication, port, username, password, and security type. It also allows you to send test emails from your WordPress dashboard to ensure your SMTP settings are correctly configured.

Features

• Easy SMTP settings configuration: Simply enter your SMTP host, authentication, port, username, password, and security type in the 'Mailer Settings
• Test Email functionality:: Verify your SMTP settings by sending a test email straight from your WordPress dashboard.

Requirements

• PHP: This plugin requires PHP 7.4 or higher.
• WordPress: A WordPress installation of 5.6 or higher is required.
• .env file: Your WordPress installation must be configured to read SMTP settings from a .env file.
• Composer: The plugin is installable via Composer from Packagist, but can also be manually downloaded and installed.

Installation

To install this plugin using Composer, simply run the following command in your terminal:

composer require wp-blueprint/plugin-mailer

After the plugin has been downloaded by Composer, you need to activate it. You can do this by going to the Plugins page in your WordPress admin dashboard, locating the plugin, and clicking "Activate".

Usage

1. After activating the plugin, navigate to the 'WPBlueprint Plugins' menu and select 'Mailer'.
2. Enter your SMTP details and save the settings.
3. You can send a test email from the 'Mailer' page to ensure that your SMTP settings are correctly configured.

Backlog

Here are some features and improvements planned for future releases:

• User Interface: Improve the user interface for better usability.
• Localization: Provide translations for the admin interface to support various languages.
• Integration: Consider integration with popular forms plugins to make your plugin more versatile.
• Multiple Configuration Features: Allow the creation of multiple "SMTP profiles", each with their own host, port, username, password, and other settings.
• Secure Credential Storage: Improve the security of SMTP credential storage, possibly integrating with secure WordPress options or other secure methods for storing sensitive data.

Development

Use the following scripts to aid in development:

• composer run lint:wpcs: WPCS Lint
• composer run lint:wpcs:fix: WPCS Fix
• composer run lint:php: PHP Lint

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve this plugin.

Please follow the WordPress Coding Standards and ensure that your changes are well-documented. Use the provided npm scripts for linting your PHP code before submitting.

License

This plugin is licensed under the GNU General Public License v3.0.