struktal/struktal-phpmailer-wrapper

PHP wrapper library to extract common settings for a PHPMailer object instance

1.0.0 2025-08-20 13:52 UTC

Requires

• php: >=8.2.0
• phpmailer/phpmailer: ^6.10.0

LGPL-2.1-only

• mail

README

This is a PHP wrapper library to extract common settings for a PHPMailer object instance

Installation

To install this library, include it in your project using Composer:

composer require struktal/struktal-phpmailer-wrapper

Usage

Before you can use this library, you need to customize a few parameters. You can do this in the startup of your application:

\struktal\MailWrapper\MailWrapper::setSetupFunction(function(\struktal\MailWrapper\MailWrapper $mailer) {
    // Set up the mailer instance here
});

Furthermore, you can specify to redirect all mails to a specific address instead of the real recipients for testing purposes:

\struktal\MailWrapper\MailWrapper::setRedirectAllMails(
    true,
    "[e-mail]" // The email address to redirect all mails to
);

Then, you can instantiate an instance of the MailWrapper class and use it just like a regular PHPMailer object for sending mails.

Dependencies

• PHPMailer - GitHub: PHPMailer/PHPMailer, licensed under LGPL-2.1 license

License

This software is licensed under the LGPL-2.1 license. See the LICENSE file for more information.