https://github.com/webfiori/mail
Sockets-based library for sending HTML email messages.
https://github.com/webfiori/mail
Last synced: 4 months ago
JSON representation
Sockets-based library for sending HTML email messages.
- Host: GitHub
- URL: https://github.com/webfiori/mail
- Owner: WebFiori
- License: mit
- Created: 2022-07-16T17:46:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-07T22:17:20.000Z (8 months ago)
- Last Synced: 2025-11-10T12:16:11.158Z (7 months ago)
- Language: PHP
- Size: 402 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WebFiori Mailer
A powerful and easy-to-use PHP library for sending HTML-based emails with SMTP support, OAuth authentication, and advanced features.
## Supported PHP Versions
| Build Status |
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 
|
| 
|
| 
|
| |
## In This Page:
* [Installation](#installation)
* [Examples](#examples)
* [Usage](#usage)
* [Basic Usage](#basic-usage)
* [Connecting to SMTP Server](#connecting-to-smtp-server)
* [Creating Email Message](#creating-email-message)
* [Setting Email Subject](#setting-email-subject)
* [Adding a Recipient](#adding-a-recipient)
* [Writing Some Text](#writing-some-text)
* [Sending The Message](#sending-the-message)
* [All Together](#all-together)
* [Fluent Interface](#fluent-interface)
* [OAuth Authentication](#oauth-authentication)
* [Attachments](#attachments)
* [Before Send Callback](#before-send-callback)
* [After Send Callback](#after-send-callback)
* [Accessing SMTP Log](#accessing-smtp-log)
* [Storing Email](#storing-email)
* [Setup Testing](#setup-testing)
## Installation
Install via Composer:
```bash
composer require webfiori/mailer
```
## Examples
Comprehensive examples are available in the [`examples/`](examples/) directory:
- **[Basic Usage](examples/basic-usage/)** - Fundamental email sending and fluent interface
- **[OAuth Authentication](examples/oauth-usage/)** - Gmail and Microsoft OAuth integration
- **[File Attachments](examples/attachments/)** - Adding files to emails
- **[Sending Modes](examples/sending-modes/)** - Test, development, and production configurations
- **[SMTP Logging](examples/accessing-log/)** - Debugging and monitoring
- **[Callbacks](examples/callbacks/)** - Before/after send custom logic
## Usage
### Basic Usage
This section describes most basic use case of the library. It shows how to connect to SMTP server, writing a message and sending it to specific address.
#### Connecting to SMTP Server
Connection information are represented using an instance of the class [`WebFiori\Mail\SMTPAccount`](https://github.com/WebFiori/mail/blob/main/WebFiori/Mail/SMTPAccount.php).
``` php
465,
//Replace server address with your mail server address
AccountOption::SERVER_ADDRESS => 'mail.example.com',
//Replace server username with your mail server username
AccountOption::USERNAME => 'test@example.com',
AccountOption::PASSWORD => 'KnvcbxFYCz77',
AccountOption::SENDER_NAME => 'Ibrahim',
//Replace sender address with your mail server sender address
AccountOption::SENDER_ADDRESS => 'test@example.com',
AccountOption::NAME => 'no-reply'
]);
```
#### Creating Email Message
After having SMTP connection information, an instance of the class [`WebFiori\Mail\Email`](https://github.com/WebFiori/mail/blob/dev/WebFiori/Mail/Email.php) can be created. The consructor of the class will accept one parameter which is the connection that will be used to connect to SMTP server.
``` php
//Second, create your actual email. using the account that was just created to
//send messages.
$email = new Email($smtp);
```
#### Setting Email Subject
To set the subject of the message, the method `Email::setSubject()` can be used as follows:
``` php
//Set subject
$email->setSubject('Hello World From PHP 😀');
```
#### Adding a Recipient
``` php
//Specify who will receive the message
$email->addTo('super-megaman-x@outlook.com');
```
#### Writing Some Text
The email messages which are created using the library are HTML based. They utilize the library [`webfiori\ui`](https://github.com/WebFiori/ui) to build the virtual DOM.
An HTML elemtnt can be inserted to the body of the message by using the method `Email::insert()`.
``` php
//Build your HTML Message
$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
The final step is to send the message. This can be performed using the method `Email::send()`.
``` php
//Finally, send.
$email->send();
```
#### All Together
When we put all the steps as one, we would have the following:
``` php
require '../vendor/autoload.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 => 'KnvcbxFYCz77',
AccountOption::SENDER_NAME => 'Ibrahim',
AccountOption::SENDER_ADDRESS => 'test@example.com',
AccountOption::NAME => 'no-reply'
]);
$email = new Email($smtp);
$email->setSubject('Hello World From PHP 😀');
$email->addTo('super-megaman-x@outlook.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();
```
### Fluent Interface
WebFiori Mailer supports method chaining for a more readable and concise syntax:
```php
$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
```php
$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
```php
$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](examples/oauth-usage/) for complete setup instructions.
## Attachments
Attachments can be added to any email using the method `Email::addAttachment()`. The method accepts a single parameter. The parameter can be a `string` which represents the absolute path of the file to be attached or an object of type `webfiori\file\File`.
``` php
use WebFiori\Mail\AccountOption;
use WebFiori\Mail\SMTPAccount;
use WebFiori\Mail\Email;
use webfiori\file\File;
$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'
]);
$email = new Email($smtp);
$email->addAttachment('Attach00.txt');
$email->addAttachment(new File('another.txt'));
```
## Before Send Callback
Suppose that a developer would like to perform a task everytime the method `Email::send()` is called, and that event must be called before connecting to SMTP server. In such case, the developer can use the method `Email::addBeforeSend()`. The method accepts two parameters, first one is a `function` callback and second one is an optional array of parameters to be passed to the callback.
``` php
$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'
]);
$email = new Email($smtp);
$email->setSubject('Hello World From PHP 😀');
$email->addTo('super-megaman-x@outlook.com');
$email->addBeforeSend(function (Email $e) {
$e->insert('p')->text('This text is added before sending');
});
$div = $email->insert('div');
$div->addChild('p')->text('Hello World Message');
$email->send();
```
## After Send Callback
Suppose that a developer would like to perform a task everytime the method `Email::send()` is called, and that event must be called after sending the email. In such case, the developer can use the method `Email::addAfterSend()`. The method accepts two parameters, first one is a `function` callback and second one is an optional array of parameters to be passed to the callback.
``` php
$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'
]);
$email = new Email($smtp);
$email->setSubject('Hello World From PHP 😀');
$email->addTo('super-megaman-x@outlook.com');
$email->addAfterSend(function (Email $e) {
// Do any action like storing the log.
});
$div = $email->insert('div');
$div->addChild('p')->text('Hello World Message');
$email->send();
```
## Accessing SMTP Log
One of the features of the library is the logging of SMTP commands that was sent to server. This is useful in case the developer would like to trace the cause of send failure. To access the log events, the method `Email::getLog()` can be used. The method will return an array that holds sub-assiciative arrays. each associative array will have 3 indices, `command`, `response-code` and `response-message`.
``` php
foreach ($email->getLog() as $logEvent) {
echo ' Command: '.$logEvent['command'];
echo ' Code: '.$logEvent['response-code'];
echo ' Message: '.$logEvent['response-message'];
}
```
## Storing Email
Since the emails which are constructed using the library are HTML based, they can be stored as HTML web pages. This feature is useful in case the developer would like to test a preview of final constructed email.
To store an email as HTML web page, the method `Email::storeEmail()` can be used as follows:
``` php
$m = new Email(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'
]));
$m->setSubject('Test Ability to Store Email');
$m->addTo('ibx@example.com');
$m->insert('p')->text('Dear,')->setStyle([
'font-weight' => 'bold',
'font-size' => '15pt'
]);
$m->insert('p')->text('This email is just to inform you that you can store emails as web pages.');
$m->insert('p')->text('Regards,')->setStyle([
'color' => 'green',
'font-weight' => 'bold'
]);
$m->storeEmail('/path/to/email/file');
```
The call to the method `Email::storeEmail()` will do the following:
* Render the final email.
* Create a folder which has same subject as the email inside provided folder.
* Create HTML file which has the date and time as its name inside the folder.
The final output of the given code will be HTML web page that is similar to following image.
## Setup Testing
When testing the email, we usually intersted on seeing the final look of the email in addition to knowing who are the recepints of the email. The library provides the developer with two options for testing email messages:
* Storing them as HTML web pages
* Sending them to specific addresses.
The two testing modes are controlled by the method `Email::setMode()`. The method is used to set the mode at which the email will use when the method `Email::send` is called.
### Storing as Web Pages
In this case, the mode of sending the message should be set to `SendMode::TEST_STORE`. Additionally, the location at which the message will be stored at must be provided.
``` php
$m = new Email(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'
]));
//Here, set the mode to testing and storing.
$m->setMode(SendMode::TEST_STORE, [
'store-path' => '/path/to/store/message'
]);
$m->setSubject('Test Ability to Store Email');
$m->addTo('ibx@example.com');
$m->insert('p')->text('Dear,')->setStyle([
'font-weight' => 'bold',
'font-size' => '15pt'
]);
$m->insert('p')->text('This email is just to inform you that you can store emails as web pages.');
$m->insert('p')->text('Regards,')->setStyle([
'color' => 'green',
'font-weight' => 'bold'
]);
$m->send();
```
### Sending to Test Addresses
In this case, the mode of sending the message should be set to `SendMode::TEST_SEND`. Additionally, the addresses of the users who will receive the email must be provided.
``` php
$m = new Email(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'
]));
//Here, set the mode to testing and storing.
$m->setMode(SendMode::TEST_SEND, [
'send-addresses' => [
'addr1@example.com',
'addr2@example.com',
]
]);
$m->setSubject('Test Ability to Store Email');
$m->addTo('ibx@example.com');
$m->insert('p')->text('Dear,')->setStyle([
'font-weight' => 'bold',
'font-size' => '15pt'
]);
$m->insert('p')->text('This email is just to inform you that you can store emails as web pages.');
$m->insert('p')->text('Regards,')->setStyle([
'color' => 'green',
'font-weight' => 'bold'
]);
$m->send();
```