Download the PHP package webfiori/mailer without Composer
On this page you can find all versions of the php package webfiori/mailer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package mailer
WebFiori Mailer
Sockets-based library for sending HTML email messages.
Table of Contents
- Motivation
- Supported PHP Versions
- Installation
- Quick Start
- Usage
- Basic Usage
- Fluent Interface
- OAuth Authentication
- Attachments
- Before Send Callback
- After Send Callback
- Accessing SMTP Log
- Storing Email
- Testing Modes
- 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:
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:
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
Quick Start
Usage
Basic Usage
Connecting to SMTP Server
Connection information is represented using an instance of the class WebFiori\Mail\SMTPAccount.
Creating Email Message
Setting Email Subject
Adding a Recipient
Writing HTML Content
The email messages are HTML based, utilizing the library webfiori/ui to build the virtual DOM.
Sending The Message
Fluent Interface
WebFiori Mailer supports method chaining for a more readable and concise syntax:
Available fluent methods:
to()- Add TO recipientcc()- Add CC recipientbcc()- Add BCC recipientsubject()- Set email subjectattach()- Add attachmentpriority()- Set email priority
OAuth Authentication
WebFiori Mailer supports OAuth2 authentication via the OAuthTokenProvider interface.
Built-in providers handle token acquisition, caching, and refresh automatically.
The token is fetched lazily — just before each send — so it is always fresh.
Microsoft 365 / Outlook (MicrosoftOAuthProvider)
Uses the Client Credentials flow against Microsoft Entra ID. No user interaction required.
Custom provider
Implement OAuthTokenProvider for any other OAuth2-capable SMTP server:
See the OAuth examples for complete setup instructions.
Amazon SES SMTP (SESCredentialHelper)
Amazon SES SMTP uses IAM credentials, not OAuth. SESCredentialHelper derives the
required SMTP password from your IAM Secret Access Key:
No special transport needed — SES SMTP uses standard AUTH LOGIN.
See the SES example for full details.
SSL/TLS Verification
By default, SSL/TLS peer verification is enabled for all connections. This means:
- The server certificate is verified against your system's CA bundle (
verify_peer = true) - The certificate hostname must match the server address (
verify_peer_name = true) - Self-signed certificates are rejected (
allow_self_signed = false)
This is the correct and secure default for any publicly trusted SMTP server.
Internal servers with self-signed certificates
Disable verification entirely (not recommended for production)
Warning: Setting
VERIFY_SSLtofalseexposes SMTP credentials to man-in-the-middle attacks. Only use it in isolated/controlled environments.
See the SSL configuration example for a full demonstration.
Connection Retry and Timeout
Failed connections are automatically retried with exponential backoff. The read timeout applies to every fgets() call after the connection is established, preventing indefinite hangs when a server becomes unresponsive mid-session.
| Option | Default | Description |
|---|---|---|
AccountOption::MAX_RETRIES |
3 |
Number of reconnect attempts after failure |
AccountOption::RETRY_DELAY |
1 |
Base delay in seconds between attempts (doubles each retry) |
Backoff schedule with defaults: attempt 1 immediate, attempt 2 waits 1s, attempt 3 waits 2s, attempt 4 waits 4s.
Note: Retries only apply to TCP connection establishment. A
SMTPExceptionthrown duringread()due to a timeout means the session state is unknown and cannot be safely retried in place — the caller should reconnect from scratch.See ADR-0032 for the full design rationale.
Message-ID and Reply Threading
Every sent email automatically gets a unique Message-ID header (RFC 5322). After calling send(), you can read it back:
To send a reply that threads correctly in email clients, set the In-Reply-To header:
Attachments
Attachments can be added using Email::addAttachment(). The parameter can be a file path string or an object of type webfiori\file\File.
Before Send Callback
Execute logic before the message is sent using Email::addBeforeSend():
After Send Callback
Execute logic after the message is sent using Email::addAfterSend():
Accessing SMTP Log
Every SMTP command is logged with its response code and message. Access log events via Email::getLog():
Storing Email
Emails can be stored as HTML web pages for preview purposes:
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
Send to Test Addresses
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
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.