Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/yii2-symfonymailer
Yii 2 Symfony mailer extension.
https://github.com/yiisoft/yii2-symfonymailer
email hacktoberfest mail mailer symfony yii2
Last synced: about 6 hours ago
JSON representation
Yii 2 Symfony mailer extension.
- Host: GitHub
- URL: https://github.com/yiisoft/yii2-symfonymailer
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2021-12-21T17:12:42.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T09:06:48.000Z (8 months ago)
- Last Synced: 2024-10-29T14:35:38.467Z (about 2 months ago)
- Topics: email, hacktoberfest, mail, mailer, symfony, yii2
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 112 KB
- Stars: 42
- Watchers: 15
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Mailer Library - Symfony Mailer Extension
This extension provides a [Symfony Mailer](https://symfony.com/doc/5.4/mailer.html) mail solution for [Yii framework 2.0](https://www.yiiframework.com).
For license information check the [LICENSE](LICENSE.md)-file.
[](https://packagist.org/packages/yiisoft/yii2-symfonymailer)
[](https://packagist.org/packages/yiisoft/yii2-symfonymailer)
[](https://github.com/yiisoft/yii2-symfonymailer/actions)
[](https://codecov.io/gh/yiisoft/yii2-symfonymailer)
[](https://github.com/yiisoft/yii2-symfonymailer/actions/workflows/static.yml)
[](https://shepherd.dev/github/yiisoft/yii2-symfonymailer)
Requirements
------------
- PHP 8.1 or higher.
Installation
------------
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiisoft/yii2-symfonymailer
```
or add
```json
"yiisoft/yii2-symfonymailer": "~3.0.0"
```
to the require section of your composer.json.
Usage
-----
To use this extension, simply add the following code in your application configuration:
```php
return [
//....
'components' => [
'mailer' => [
'class' => \yii\symfonymailer\Mailer::class,
'transport' => [
'scheme' => 'smtps',
'host' => '',
'username' => '',
'password' => '',
'port' => 465,
'dsn' => 'native://default',
],
'viewPath' => '@common/mail',
// send all mails to a file by default. You have to set
// 'useFileTransport' to false and configure transport
// for the mailer to send real emails.
'useFileTransport' => false,
],
],
];
```
or
```php
return [
//....
'components' => [
'mailer' => [
'class' => \yii\symfonymailer\Mailer::class,
'transport' => [
'dsn' => 'smtp://user:[email protected]:25',
],
],
],
];
```
You can then send an email as follows:
```php
Yii::$app->mailer->compose('contact/html')
->setFrom('[email protected]')
->setTo($form->email)
->setSubject($form->subject)
->send();
```
DI Container
------------
The `Mailer` component will automatically use the DI container when it is available.
This allows you to easily override the transport factory configurations or their dependencies.
Migrating from yiisoft/yii2-swiftmailer
---------------------------------------
To migrate from the deprecated [yiisoft/yii2-swiftmailer](https://github.com/yiisoft/yii2-swiftmailer) to this extension you need to update the application config.
Swiftmailer default transport was the `SendmailTransport`, while with this extension it will default to a `NullTransport` (sends no mail). You can use the swiftmailer default like the following:
```php
'mailer' => [
'class' => yii\symfonymailer\Mailer::class,
'transport' => [
'dsn' => 'sendmail://default',
],
],
```
With this extension, you do not have an ability of directly setting timeout, or other configurations that were possible with Swiftmailer extension. The reason is, the underlying Symfony package defines its classes as `final` thereby discouraging inheritance and pushing towards composition.
To achieve timeout, for example (and other transport configurations supported), you will need to define factory class and override default transport factory you are interested to replace through [Yii DI container](https://www.yiiframework.com/doc/guide/2.0/en/concept-di-container) definitions.
Below is an example that shows you how to ovveride timeout.
First define your custom factory class.
```php
namespace app\utils;
use Symfony\Component\Mailer\Transport\Dsn;
use Symfony\Component\Mailer\Transport\Smtp\SmtpTransport;
use Symfony\Component\Mailer\Transport\TransportFactoryInterface;
use Symfony\Component\Mailer\Transport\TransportInterface;
use yii\base\BaseObject;
final class CustomSmtpFactory extends BaseObject implements TransportFactoryInterface
{
public float $timeout;
public function create(Dsn $dsn): TransportInterface
{
$transport = $this->create($dsn);
if ($transport instanceof SmtpTransport) {
/** @var SocketStream $stream */
$stream = $transport->getStream();
$stream->setTimeout($this->timeout);
}
return $transport;
}
public function supports(Dsn $dsn): bool
{
return $dsn->getScheme() == 'smtp';
}
}
```
Then in the root of web configuration, set the factory class in container definitions, thereby overriding the default class.
```php
'container' => [
'definitions' => [
EsmtpTransportFactory::class => [
'class' => \app\utils\CustomSmtpFactory::class,
'timeout' => 143, //Configure it to your own timeout
],
// ... other definitions
],
],
```
That is all you need to do. The extension should use your new class and its configuration settings.
Security implications of the DSN
--------------------------------
While the DSN might seem like a simple way to allow user configurable mailer settings it should be noted that the sendmail transport allows for execution of local executables.
If you need to have a user configurable DSN (which is easier to build and more powerful to use than creating a GUI) you should probably disable the sendmail transport.
Any user who has the power to configure a DSN essentially has shell access to wherever the code is running.
## Testing
[Check the documentation testing](/docs/testing.md) to learn about testing.