https://github.com/yiisoft/yii2-swiftmailer

Yii 2 swiftmailer extension.
https://github.com/yiisoft/yii2-swiftmailer

email hacktoberfest mail mailer swiftmailer yii yii2

Last synced: 29 days ago
JSON representation

Yii 2 swiftmailer extension.

• Host: GitHub
• URL: https://github.com/yiisoft/yii2-swiftmailer
• Owner: yiisoft
• License: bsd-3-clause
• Created: 2013-11-08T03:38:16.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T03:42:35.000Z (11 months ago)
• Last Synced: 2024-03-21T14:40:03.894Z (8 months ago)
• Topics: email, hacktoberfest, mail, mailer, swiftmailer, yii, yii2
• Language: PHP
• Homepage: http://www.yiiframework.com
• Size: 9.47 MB
• Stars: 117
• Watchers: 28
• Forks: 72
• Open Issues: 2
• 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

        


    

        

    

    
SwiftMailer Extension for Yii 2

    


This extension provides a [SwiftMailer](https://swiftmailer.symfony.com/) mail solution for [Yii framework 2.0](https://www.yiiframework.com).

For license information check the [LICENSE](LICENSE.md)-file.

[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2-swiftmailer/v/stable.png)](https://packagist.org/packages/yiisoft/yii2-swiftmailer)

[![Total Downloads](https://poser.pugx.org/yiisoft/yii2-swiftmailer/downloads.png)](https://packagist.org/packages/yiisoft/yii2-swiftmailer)

[![Build Status](https://github.com/yiisoft/yii2-swiftmailer/workflows/build/badge.svg)](https://github.com/yiisoft/yii2-swiftmailer/actions)

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-swiftmailer

```

or add

```json

"yiisoft/yii2-swiftmailer": "~2.1.0"

```

to the require section of your composer.json.

> Note: Version 2.1 of this extensions uses Swiftmailer 6, which requires PHP 7. If you are using PHP 5, 

> you have to use version 2.0 of this extension, which uses Swiftmailer 5, which is compatible with 

> PHP 5.4 and higher. Use the following version constraint in that case:

> 

> ```json

> "yiisoft/yii2-swiftmailer": "~2.0.0"

> ```

Usage

-----

To use this extension,  simply add the following code in your application configuration:

```php

return [

    //....

    'components' => [

        'mailer' => [

            'class' => 'yii\swiftmailer\Mailer',

        ],

    ],

];

```

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();

```

For further instructions refer to the [related section in the Yii Definitive Guide](https://www.yiiframework.com/doc-2.0/guide-tutorial-mailing.html).