kanboard_ynh/sources/doc/plugin-mail-transports.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():

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:

$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
• Mailgun
• Postmark