sweelix / yii2-postmark
PHP 5.6+ PostmarkApp integration for the Yii framework
Installs: 107 802
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 4
Forks: 3
Open Issues: 0
Type:yii2-extension
Requires
- php: >=5.6.0
- wildbit/postmark-php: *
- yiisoft/yii2: >=2.0.4
Requires (Dev)
- php: >=5.6.0
- codeception/codeception: *
This package is not auto-updated.
Last update: 2024-12-22 03:00:39 UTC
README
This extension allow the developper to use PostmarkApp as an email transport.
Installation
If you use Packagist for installing packages, then you can update your composer.json like this :
{ "require": { "sweelix/yii2-postmark": "*" } }
Howto use it
Add extension to your configuration
return [ //.... 'components' => [ 'mailer' => [ 'class' => 'sweelix\postmark\Mailer', 'token' => '<your postmark token>', ], ], ];
You can send email as follow (using postmark templates)
Yii::$app->mailer->compose('contact/html') ->setFrom('from@domain.com') ->setTo($form->email) ->setSubject($form->subject) ->setTemplateId(12345) ->setTemplateModel([ 'firstname' => $form->firstname, 'lastname' => $form->lastname, ->send();
For further instructions refer to the related section in the Yii Definitive Guide
Running the tests
Before running the tests, you should edit the file tests/_bootstrap.php and change the defines :
// ... define('POSTMARK_FROM', '<sender>'); define('POSTMARK_TOKEN', '<token>'); define('POSTMARK_TO', '<target>'); define('POSTMARK_TEMPLATE', 575741); define('POSTMARK_TEST_SEND', false); // ...
to match your PostmarkApp configuration.
Contributing
All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.
Fork the project, create a feature branch , and send us a pull request.