rotmailer/rotmailer

A lightweight PHP library for rotating email delivery across multiple SMTP accounts, helping bypass sending limits and improve deliverability.

v1.0.0 2024-11-08 23:11 UTC

Requires

• php: >=7.0.0
• phpmailer/phpmailer: ^6.9

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Paul Robert

• PHP mail
• php email
• PHP SMTP
• email library
• email sending
• smtp rotation
• smtp load balancing
• rotating mailer
• smtp accounts
• email deliverability

README

A simple PHP library that rotates email sending between multiple SMTP accounts to bypass sending limits.

Features

• Randomized SMTP account selection for load balancing.
• Supports single and multiple recipients.
• Allows custom email content, including HTML and plain text.
• Easily configurable and extendable.

Installation

Install the library using Composer:

composer require rotmailer/rotmailer

Requirements

• PHP 7.0 or higher
• PHPMailer
• Enabled ext-dom PHP extension (required by PHPMailer)

Usage

1. Create SMTP Configuration

Define your SMTP accounts as an array of configurations:

$smtpConfigs = [
    [
        'host' => 'smtp.example.com',
        'username' => '[e-mail]',
        'password' => 'password1',
        'encryption' => 'tls',
        'port' => 587,
        'from' => ['[e-mail]', 'Example Support']
    ],
    [
        'host' => 'smtp.another.com',
        'username' => '[e-mail]',
        'password' => 'password2',
        'encryption' => 'ssl',
        'port' => 465,
        'from' => ['[e-mail]', 'Another Support']
    ]
];

2. Initialize RotMailer

Pass the SMTP configurations to the RotMailer class and start sending emails:

require 'vendor/autoload.php';

use RotMailer\RotMailer;

$mailer = new RotMailer($smtpConfigs);

try {
    $mailer->randomizeSMTP()
           ->addRecipient('[e-mail]')
           ->setSubject('Test Email')
           ->setBody('<h1>Hello, World!</h1>')
           ->send();

    echo "Email sent successfully!";
} catch (\RuntimeException $e) {
    echo "Error: " . $e->getMessage();
}

API

__construct(array $smtpConfigs)

Initializes the RotMailer with an array of SMTP configurations.

randomizeSMTP(int $debug = 0): self

Selects a random SMTP configuration and sets it for the email. Optionally enable debugging with $debug.

setFrom(string $fromEmail, string $fromName): self

Sets the "From" address.

addRecipient(string $to): self

Adds a single recipient.

addRecipients(array $recipients): self

Adds multiple recipients.

setSubject(string $subject): self

Sets the email subject.

setBody(string $body, bool $isHTML = true): self

Sets the email body. Supports both HTML and plain text.

addAttachment(string $filePath, string $fileName = ''): self

Adds an attachment to the email.

send(): bool

Sends the email. Returns true on success or throws a RuntimeException on failure.

Testing

Run the tests using PHPUnit:

php vendor/bin/phpunit tests

Contributing

Contributions are welcome! Please open an issue or submit a pull request with your improvements.

License

RotMailer is licensed under the MIT License. See the LICENSE file for details.