jimderonde/wp-mailer

Composer package for Gewest13's Wordpress mailer.

2.4.0 2025-11-28 09:43 UTC

Requires

• phpmailer/phpmailer: ^6.1
• vlucas/phpdotenv: ^4.1

MIT

• Jim de Ronde
• Ruud Luijten

README

This is a Wordpress module developed by Jim de Ronde (Gewest13).

Prerequisites

• ACF Pro

Installation

Do this first.

1. Clone the repository in your server/ directory.
2. Do a composer install inside the folder.
3. Require or include the server/wp-mailer/autoload.php into your functions.php file.
4. Please note that a hook within Wordpress is including a javascript file into the footer. Import it as you like whenever you desire a bundle over multiple javascript files.

When this is done a first form can be added.

1. Create a .env file in the root of your template folder with the credentials as presented in the example file .example.env.
2. Create a new form and add any field to your liking.
3. Add the /sample-component/ to your list of components/. Please note that the form will require some predefined settings like an action, data-wp-mailer and method.
4. At last, please include wp_footer() before the ending of your </body> tag. Please not that the entire function will be cleared and will only return the javascript file that will take care of the asynchronous requests.
5. If desired, add the following rule to your .css file in order to hide the badge: .grecaptcha-badge {display: none}

Environment variables

• MAIL_FROM_EMAIL lets you override the sender email used when dispatching messages (useful when your SMTP provider requires a specific from address such as Resend). When not set, the SMTP username is used as the sender while replies continue to go to the original form email when different.
• RECAPTCHA_MIN_SCORE allows you to configure the minimum acceptable reCAPTCHA v3 score (defaults to 0.5).

Functions

Always check if $mailer is a valid instance of the Mailer class.

1. Use $mailer->getForm($id) to get all form fields.
2. Then, use a foreach loop to loop through all fields. foreach ($mailer->getForm($id) as $name => $field).
3. Inside the loop the $field->field variable will contain the entire html element so use $mailer->parseField($field->field, "classes") to parse it.
4. Label can be accessed through $field->label.
5. Name can be accessed through $field->name.
6. Field type can be accessed through $field->type.