mirror of
https://github.com/YunoHost-Apps/kanboard_ynh.git
synced 2024-09-03 19:36:17 +02:00
51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
|
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.
|
||
|
|
By example, your plugin can add a mail transport for a provider that uses an HTTP API.
|
||
|
|
|
||
|
|
Implementation
|
||
|
|
--------------
|
||
|
|
|
||
|
|
Your plugin must implements 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 $email
|
||
|
|
* @param string $name
|
||
|
|
* @param string $subject
|
||
|
|
* @param string $html
|
||
|
|
* @param string $author
|
||
|
|
*/
|
||
|
|
public function sendEmail($email, $name, $subject, $html, $author);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
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 namespace 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)
|