alexeevdv / yii2-slack-mailer

2.0.0 2018-07-16 05:28 UTC

Requires

• maknz/slack: ~1.7
• yiisoft/yii2: ~2.0

Requires (Dev)

• codeception/codeception: ~2.4.0
• yiisoft/yii2-coding-standards: ~2.0.0

MIT

• Dmitry Alekseev

Published on Packagist.org on 2018-07-16 05:28 UTC

README

Yii2 mailer implementation that send mails to specified webhook.

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require alexeevdv/yii2-slack-mailer "~2.0"

or add

"alexeevdv/yii2-slack-mailer": "~2.0"

to the require section of your composer.json file.

Configuration

Through application component

use alexeevdv\yii\SlackMailer;

//...
'components' => [
    //...
    'mailer' => [
        'class' => SlackMailer::class,
        'webhook' => 'https://your_webhook_link',
    ],
    //...
],
//...

Available params

• webhook

  • description: Your webhook URL
  • required: true
  • type: string

• icon

  • description: :emoji: or URL to image
  • required: false
  • type: string

• channel

  • description: Channel name
  • required: false
  • type: string

• username

  • description: Bot name
  • required: false
  • type: string

• link_names

  • required: false
  • type: boolean
  • default: false

• unfurl_links

  • required: false
  • type: boolean
  • default: true

• unfurl_media

  • required: false
  • type: boolean
  • default: true

• allow_markdown

  • required: false
  • type: boolean
  • default: true