Sabre\CalDAV\Schedule\IMipPlugin Class Reference

iMIP handler. More...

Inheritance diagram for Sabre\CalDAV\Schedule\IMipPlugin:

Collaboration diagram for Sabre\CalDAV\Schedule\IMipPlugin:

Public Member Functions
	__construct ($senderEmail)
	Creates the email handler. More...
	initialize (DAV\Server $server)
	getPluginName ()
	Returns a plugin name. More...
	schedule (ITip\Message $iTipMessage)
	Event handler for the 'schedule' event. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...
Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...
	getPluginName ()
	Returns a plugin name. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Protected Member Functions
	mail ($to, $subject, $body, array $headers)
	This function is responsible for sending the actual email. More...

Protected Attributes
	$senderEmail
	$itipMessage

Detailed Description

iMIP handler.

This class is responsible for sending out iMIP messages. iMIP is the email-based transport for iTIP. iTIP deals with scheduling operations for iCalendar objects.

If you want to customize the email that gets sent out, you can do so by extending this class and overriding the sendMessage method.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 22 of file IMipPlugin.php.

Constructor & Destructor Documentation

__construct()

Sabre\CalDAV\Schedule\IMipPlugin::__construct

(

$senderEmail

)

Creates the email handler.

Parameters

string

$senderEmail,.

The 'senderEmail' is the email that shows up in the 'From:' address. This should generally be some kind of no-reply email address you own.

Definition at line 46 of file IMipPlugin.php.

References Sabre\CalDAV\Schedule\IMipPlugin\$senderEmail.

                                       {

        $this->senderEmail = $senderEmail;

    }

Member Function Documentation

getPluginInfo()

Sabre\CalDAV\Schedule\IMipPlugin::getPluginInfo

(

)

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns

array

Definition at line 180 of file IMipPlugin.php.

References Sabre\CalDAV\Schedule\IMipPlugin\getPluginName().

                             {

        return [
            'name'        => $this->getPluginName(),
            'description' => 'Email delivery (rfc6047) for CalDAV scheduling',
            'link'        => 'http://sabre.io/dav/scheduling/',
        ];

    }

Here is the call graph for this function:

getPluginName()

Sabre\CalDAV\Schedule\IMipPlugin::getPluginName

(

)

Returns a plugin name.

Using this name other plugins will be able to access other plugins using ::getPlugin

Returns

string

Definition at line 77 of file IMipPlugin.php.

Referenced by Sabre\CalDAV\Schedule\IMipPlugin\getPluginInfo().

                             {

        return 'imip';

    }

Here is the caller graph for this function:

initialize()

Sabre\CalDAV\Schedule\IMipPlugin::initialize

(

DAV\Server

$server

)

Definition at line 63 of file IMipPlugin.php.

                                            {

        $server->on('schedule', [$this, 'schedule'], 120);

    }

mail()

Sabre\CalDAV\Schedule\IMipPlugin::mail (   $to,   $subject,   $body, array  $headers  )

protected

This function is responsible for sending the actual email.

Parameters

string	$to	Recipient email address
string	$subject	Subject of the email
string	$body	iCalendar body
array	$headers	List of headers

Returns

void

Definition at line 161 of file IMipPlugin.php.

Referenced by Sabre\CalDAV\Schedule\IMipPlugin\schedule().

                                                                  {

        mail($to, $subject, $body, implode("\r\n", $headers));

    }

Here is the caller graph for this function:

schedule()

Sabre\CalDAV\Schedule\IMipPlugin::schedule

(

ITip\Message

$iTipMessage

)

Event handler for the 'schedule' event.

Parameters

ITip\Message

$iTipMessage

Returns

void

Definition at line 89 of file IMipPlugin.php.

References Sabre\DAV\Server\$exposeVersion, Sabre\CalDAV\Schedule\IMipPlugin\$senderEmail, $summary, Sabre\CalDAV\Schedule\IMipPlugin\mail(), and Sabre\DAV\Version\VERSION.

                                                 {

        // Not sending any emails if the system considers the update
        // insignificant.
        if (!$iTipMessage->significantChange) {
            if (!$iTipMessage->scheduleStatus) {
                $iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
            }
            return;
        }

        $summary = $iTipMessage->message->VEVENT->SUMMARY;

        if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto')
            return;

        if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto')
            return;

        $sender = substr($iTipMessage->sender, 7);
        $recipient = substr($iTipMessage->recipient, 7);

        if ($iTipMessage->senderName) {
            $sender = $iTipMessage->senderName . ' <' . $sender . '>';
        }
        if ($iTipMessage->recipientName) {
            $recipient = $iTipMessage->recipientName . ' <' . $recipient . '>';
        }

        $subject = 'SabreDAV iTIP message';
        switch (strtoupper($iTipMessage->method)) {
            case 'REPLY' :
                $subject = 'Re: ' . $summary;
                break;
            case 'REQUEST' :
                $subject = $summary;
                break;
            case 'CANCEL' :
                $subject = 'Cancelled: ' . $summary;
                break;
        }

        $headers = [
            'Reply-To: ' . $sender,
            'From: ' . $this->senderEmail,
            'Content-Type: text/calendar; charset=UTF-8; method=' . $iTipMessage->method,
        ];
        if (DAV\Server::$exposeVersion) {
            $headers[] = 'X-Sabre-Version: ' . DAV\Version::VERSION;
        }
        $this->mail(
            $recipient,
            $subject,
            $iTipMessage->message->serialize(),
            $headers
        );
        $iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';

    }

Here is the call graph for this function:

Field Documentation

$itipMessage

Sabre\CalDAV\Schedule\IMipPlugin::$itipMessage

protected

Definition at line 36 of file IMipPlugin.php.

$senderEmail

Sabre\CalDAV\Schedule\IMipPlugin::$senderEmail

protected

Definition at line 29 of file IMipPlugin.php.

Referenced by Sabre\CalDAV\Schedule\IMipPlugin\__construct(), and Sabre\CalDAV\Schedule\IMipPlugin\schedule().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/CalDAV/Schedule/IMipPlugin.php