diff options
Diffstat (limited to 'doc/en_US/plugin-mail-transports.markdown')
-rw-r--r-- | doc/en_US/plugin-mail-transports.markdown | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/doc/en_US/plugin-mail-transports.markdown b/doc/en_US/plugin-mail-transports.markdown deleted file mode 100644 index f3f9efc6..00000000 --- a/doc/en_US/plugin-mail-transports.markdown +++ /dev/null @@ -1,51 +0,0 @@ -Plugin: Add Mail Transport -========================== - -By default Kanboard supports 3 standards mail transports: - -- Mail (PHP mail function) -- Smtp -- Sendmail command - -With the plugin API you can add a driver for any email provider. -For example, your plugin can add a mail transport for a provider that uses an HTTP API. - -Implementation --------------- - -Your plugin must implement the interface `Kanboard\Core\Mail\ClientInterface` and extends from `Kanboard\Core\Base`. - -The only method you need to implement is `sendEmail()`: - -```php -interface ClientInterface -{ - /** - * Send a HTML email - * - * @access public - * @param string $recipientEmail - * @param string $recipientName - * @param string $subject - * @param string $html - * @param string $authorName - * @param string $authorEmail - */ - public function sendEmail($recipientEmail, $recipientName, $subject, $html, $authorName, $authorEmail = ''); -} -``` - -To register your new mail transport, use the method `setTransport($transport, $class)` from the class `Kanboard\Core\Mail\Client`: - -```php -$this->emailClient->setTransport('myprovider', '\Kanboard\Plugin\MyProvider\MyEmailHandler'); -``` - -The second argument contains the absolute name space of your concrete class. - -Examples of mail transport plugins ----------------------------------- - -- [Sendgrid](https://github.com/kanboard/plugin-sendgrid) -- [Mailgun](https://github.com/kanboard/plugin-mailgun) -- [Postmark](https://github.com/kanboard/plugin-postmark) |