README

Sockets-based library for sending HTML email messages.

Motivation
Supported PHP Versions
Installation
Quick Start
Usage
Examples
Testing
Contributing
License
Support
Changelog

Motivation

HTML-First Composition

Most mailing libraries treat the email body as a string you pass in. WebFiori Mailer treats emails as HTML documents you build using a virtual DOM. You compose emails the same way you'd build a web page — inserting elements, nesting children, setting styles programmatically:

$div = $email->insert('div');
$div->addChild('p')->text('Hello!');
$div->addChild('p', ['style' => ['color' => 'red']])->text('Important message.');

No raw HTML strings. No template engine required (though templates are supported too).

Minimal Dependencies

The library relies only on two lightweight packages (webfiori/ui for DOM building and webfiori/file for attachments). The SMTP layer is built directly on PHP sockets. No heavy third-party dependencies to keep up with.

Built-in Testing Modes

Testing emails shouldn't require actually sending them or setting up third-party services:

Store mode — Renders the email as a local HTML file for visual inspection, complete with headers metadata.
Test send mode — Redirects messages to specified test addresses regardless of the actual recipients.

Switch between modes with a single call:

$email->setMode(SendMode::TEST_STORE, ['store-path' => '/tmp/emails']);

SMTP Transparency

Every command sent to the SMTP server is logged with its response code and message. When something fails, you see exactly what happened at the protocol level — no black-box debugging.

Lightweight and Self-Contained

The entire library is a handful of classes. If all you need is to send HTML emails over SMTP without pulling in a large framework or dozens of transitive dependencies, this gets the job done.

Supported PHP Versions

Build Status

Installation

composer require webfiori/mailer

Quick Start

<?php
use WebFiori\Mail\AccountOption;
use WebFiori\Mail\SMTPAccount;
use WebFiori\Mail\Email;

$smtp = new SMTPAccount([
    AccountOption::PORT => 465,
    AccountOption::SERVER_ADDRESS => 'mail.example.com',
    AccountOption::USERNAME => 'test@example.com',
    AccountOption::PASSWORD => 'secret',
    AccountOption::SENDER_NAME => 'My App',
    AccountOption::SENDER_ADDRESS => 'test@example.com',
    AccountOption::NAME => 'no-reply'
]);

$email = new Email($smtp);

$email->setSubject('Hello World From PHP 😀');
$email->addTo('recipient@example.com');

$div = $email->insert('div');
$div->addChild('p')->text('Hello World Message');
$div->addChild('p', ['style' => ['font-weight' => 'bold', 'color' => 'red']])
    ->text('This is just a test message.');

$email->send();

Usage

Basic Usage

Connecting to SMTP Server

Connection information is represented using an instance of the class WebFiori\Mail\SMTPAccount.

<?php
use WebFiori\Mail\SMTPAccount;
use WebFiori\Mail\AccountOption;

$smtp = new SMTPAccount([
    AccountOption::PORT => 465,
    AccountOption::SERVER_ADDRESS => 'mail.example.com',
    AccountOption::USERNAME => 'test@example.com',
    AccountOption::PASSWORD => 'KnvcbxFYCz77',
    AccountOption::SENDER_NAME => 'Ibrahim',
    AccountOption::SENDER_ADDRESS => 'test@example.com',
    AccountOption::NAME => 'no-reply'
]);

Creating Email Message

use WebFiori\Mail\Email;

$email = new Email($smtp);

Setting Email Subject

$email->setSubject('Hello World From PHP 😀');

Adding a Recipient

$email->addTo('recipient@example.com');

Writing HTML Content

The email messages are HTML based, utilizing the library webfiori/ui to build the virtual DOM.

$div = $email->insert('div');
$div->addChild('p')->text('Hello World Message');
$div->addChild('p', [
    'style' => [
        'font-weight' => 'bold',
        'color' => 'red'
    ]
])->text('This is just a test message.');

Sending The Message

$email->send();

Fluent Interface

WebFiori Mailer supports method chaining for a more readable and concise syntax:

$email = new Email($smtpAccount);

$email->to('recipient@example.com', 'Recipient Name')
      ->cc('manager@example.com', 'Manager')
      ->subject('Hello from WebFiori Mailer!')
      ->priority(1)
      ->send();

Available fluent methods:

to() - Add TO recipient
cc() - Add CC recipient
bcc() - Add BCC recipient
subject() - Set email subject
attach() - Add attachment
priority() - Set email priority

OAuth Authentication

WebFiori Mailer supports OAuth2 authentication for enhanced security with modern email providers:

Gmail OAuth

$gmailAccount = new SMTPAccount([
    AccountOption::SERVER_ADDRESS => 'smtp.gmail.com',
    AccountOption::PORT => 587,
    AccountOption::USERNAME => 'your-email@gmail.com',
    AccountOption::ACCESS_TOKEN => 'your-oauth-access-token',
    AccountOption::SENDER_ADDRESS => 'your-email@gmail.com',
    AccountOption::SENDER_NAME => 'Your Name',
    AccountOption::NAME => 'gmail-oauth'
]);

Microsoft OAuth

$microsoftAccount = new SMTPAccount([
    AccountOption::SERVER_ADDRESS => 'smtp-mail.outlook.com',
    AccountOption::PORT => 587,
    AccountOption::USERNAME => 'your-email@outlook.com',
    AccountOption::ACCESS_TOKEN => 'your-microsoft-oauth-token',
    AccountOption::SENDER_ADDRESS => 'your-email@outlook.com',
    AccountOption::SENDER_NAME => 'Your Name',
    AccountOption::NAME => 'microsoft-oauth'
]);

See the OAuth examples for complete setup instructions.

Attachments

Attachments can be added using Email::addAttachment(). The parameter can be a file path string or an object of type webfiori\file\File.

use webfiori\file\File;

$email->addAttachment('Attach00.txt');
$email->addAttachment(new File('another.txt'));

Before Send Callback

Execute logic before the message is sent using Email::addBeforeSend():

$email->addBeforeSend(function (Email $e) {
    $e->insert('p')->text('This text is added before sending');
});

After Send Callback

Execute logic after the message is sent using Email::addAfterSend():

$email->addAfterSend(function (Email $e) {
    // Do any action like storing the log.
});

Accessing SMTP Log

Every SMTP command is logged with its response code and message. Access log events via Email::getLog():

foreach ($email->getLog() as $logEvent) {
    echo ' Command: '.$logEvent['command'];
    echo ' Code: '.$logEvent['response-code'];
    echo ' Message: '.$logEvent['response-message'];
}

Storing Email

Emails can be stored as HTML web pages for preview purposes:

$email->storeEmail('/path/to/email/file');

This will:

Render the final email
Create a folder named after the email subject
Create an HTML file named with the current date and time

Testing Modes

The library provides two testing modes controlled by Email::setMode():

Store as Web Pages

$email->setMode(SendMode::TEST_STORE, [
    'store-path' => '/path/to/store/message'
]);

$email->send(); // Stores instead of sending

Send to Test Addresses

$email->setMode(SendMode::TEST_SEND, [
    'send-addresses' => [
        'addr1@example.com',
        'addr2@example.com',
    ]
]);

$email->send(); // Sends to test addresses only

Examples

Comprehensive examples are available in the examples/ directory:

Basic Usage - Fundamental email sending and fluent interface
OAuth Authentication - Gmail and Microsoft OAuth integration
File Attachments - Adding files to emails
Sending Modes - Test, development, and production configurations
SMTP Logging - Debugging and monitoring
Callbacks - Before/after send custom logic
Custom Transports - Connection reuse and pluggable transports

Testing

# Install dependencies
composer install

# Run tests
composer test

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This library is licensed under the MIT License. See the LICENSE file for more details.

Support

If you encounter any issues, please open an issue on GitHub.

Changelog

See CHANGELOG.md for a list of changes.

webfiori/mailer

包简介

关键字：

README 文档