Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berliozframework/mailer
Berlioz Mailer is a PHP library for sending mail, with or without local server.
https://github.com/berliozframework/mailer
Last synced: about 1 month ago
JSON representation
Berlioz Mailer is a PHP library for sending mail, with or without local server.
- Host: GitHub
- URL: https://github.com/berliozframework/mailer
- Owner: BerliozFramework
- License: mit
- Created: 2017-08-30T16:16:21.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-09-07T13:18:04.000Z (over 3 years ago)
- Last Synced: 2024-11-21T14:17:12.457Z (about 1 month ago)
- Language: PHP
- Homepage: https://getberlioz.com
- Size: 99.6 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Berlioz Mailer
[](https://github.com/BerliozFramework/Mailer/releases)
[](https://github.com/BerliozFramework/Mailer/blob/main/LICENSE)
[](https://github.com/BerliozFramework/Mailer/actions/workflows/tests.yml?query=branch%3Amain)
[](https://www.codacy.com/manual/BerliozFramework/Mailer)
[](https://packagist.org/packages/berlioz/mailer)
**Berlioz Mailer** is a PHP library for sending mail, with or without local server.
## Installation
### Composer
You can install **Berlioz Mailer** with [Composer](https://getcomposer.org/), it's the recommended installation.
```bash
$ composer require berlioz/mailer
```
### Dependencies
* **PHP** ^7.1 || ^8.0
* PHP extensions:
* **FileInfo**
* Packages:
* **psr/log**
## Usage
### Example
You can send simply the like this:
```php
use Berlioz\Mailer\Address;
use Berlioz\Mailer\Mail;
use Berlioz\Mailer\Mailer;
$mail = (new Mail())
->setSubject('Test of Berlioz/Mailer')
->setText('Text plain of my mail')
->setHtml('
Html text of my mail
')
->setFrom(new Address('[email protected]', 'Me the sender'))
->setTo([new Address('[email protected]', 'The recipient')]);
$mailer = new Mailer();
$mailer->send($mail);
```
### Mail
**\Berlioz\Mailer\Mail** it's the object representation of a mail.
#### Basic
```php
use Berlioz\Mailer\Address;
use Berlioz\Mailer\Mail;
$mail = new Mail();
$mail->setSubject('Subject of my mail')
->setText('Text plain of my mail')
->setHtml('
Html text of my mail
')
->setFrom(new Address('[email protected]', 'Me the sender'))
->setTo([new Address('[email protected]', 'The recipient')]);
```
#### Attachments
To add downloadable attachment:
```php
use Berlioz\Mailer\Attachment;use Berlioz\Mailer\Mail;$attachment = new Attachment('/path/of/my/file.pdf');
$mail = new Mail();
$mail->addAttachment($attachment);
```
To attach an attachment to HTML content:
```php
use Berlioz\Mailer\Attachment;use Berlioz\Mailer\Mail;$attachment = new Attachment('/path/of/my/img.jpg');
$mail = new Mail();
$mail->addAttachment($attachment);
$html = '
Html content 1
';
$html .= '![]()
';
$html .= 'Html content 2
';
$mail->setHtml($html);
```
**WARNING:** call `$attachment->getId()` method, does that the attachment will be in inline disposition. Only uses this method for inline attachments.
### Transports
#### Defaults transports
Default transport is **\Berlioz\Mailer\Transport\PhpMail** uses internal **mail()** of PHP.
You can uses another available transport for direct communication with SMTP server: **\Berlioz\Mailer\Transport\Smtp**.
```php
use Berlioz\Mailer\Mailer;
use Berlioz\Mailer\Transport\Smtp;
$smtp = new Smtp(
'smpt.test.com',
'[email protected]',
'password',
25,
['timeout' => 5]
);
$mailer = new Mailer();
$mailer->setTransport($smtp);
```
```php
use Berlioz\Mailer\Mailer;
$mailer = new Mailer([
'transport' => [
'name' => 'smtp',
'arguments' => [
'host' => 'smpt.test.com',
'username' => '[email protected]',
'password' => 'password',
'port' => 25,
'options' => ['timeout' => 5]
]
]
]);
```
#### Create a new transport
It's possible to create new transport for various reasons.
To do that, you need to create class who implements **\Berlioz\Mailer\Transport\TransportInterface** interface.