IMipPlugin
extends ServerPlugin
in package
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.
Tags
Table of Contents
- $itipMessage : Message
- ITipMessage.
- $senderEmail : string
- Email address used in From: header.
- __construct() : mixed
- Creates the email handler.
- getFeatures() : array<string|int, mixed>
- This method should return a list of server-features.
- getHTTPMethods() : array<string|int, mixed>
- Use this method to tell the server this plugin defines additional HTTP methods.
- getPluginInfo() : array<string|int, mixed>
- Returns a bunch of meta-data about the plugin.
- getPluginName() : string
- Returns a plugin name.
- getSupportedReportSet() : array<string|int, mixed>
- Returns a list of reports this plugin supports.
- initialize() : mixed
- This initializes the plugin.
- schedule() : mixed
- Event handler for the 'schedule' event.
- mail() : mixed
- This function is responsible for sending the actual email.
Properties
$itipMessage
ITipMessage.
protected
Message
$itipMessage
$senderEmail
Email address used in From: header.
protected
string
$senderEmail
Methods
__construct()
Creates the email handler.
public
__construct(mixed $senderEmail) : mixed
Parameters
- $senderEmail : mixed
Return values
mixed —getFeatures()
This method should return a list of server-features.
public
getFeatures() : array<string|int, mixed>
This is for example 'versioning' and is added to the DAV: header in an OPTIONS response.
Return values
array<string|int, mixed> —getHTTPMethods()
Use this method to tell the server this plugin defines additional HTTP methods.
public
getHTTPMethods(string $path) : array<string|int, mixed>
This method is passed a uri. It should only return HTTP methods that are available for the specified uri.
Parameters
- $path : string
Return values
array<string|int, mixed> —getPluginInfo()
Returns a bunch of meta-data about the plugin.
public
getPluginInfo() : array<string|int, mixed>
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.
Return values
array<string|int, mixed> —getPluginName()
Returns a plugin name.
public
getPluginName() : string
Using this name other plugins will be able to access other plugins using \Sabre\DAV\Server::getPlugin
Return values
string —getSupportedReportSet()
Returns a list of reports this plugin supports.
public
getSupportedReportSet(string $uri) : array<string|int, mixed>
This will be used in the {DAV:}supported-report-set property. Note that you still need to subscribe to the 'report' event to actually implement them
Parameters
- $uri : string
Return values
array<string|int, mixed> —initialize()
This initializes the plugin.
public
initialize(Server $server) : mixed
This function is called by Sabre\DAV\Server, after addPlugin is called.
This method should set up the required event subscriptions.
Parameters
- $server : Server
Return values
mixed —schedule()
Event handler for the 'schedule' event.
public
schedule(Message $iTipMessage) : mixed
Parameters
- $iTipMessage : Message
Return values
mixed —mail()
This function is responsible for sending the actual email.
protected
mail(string $to, string $subject, string $body, array<string|int, mixed> $headers) : mixed
Parameters
- $to : string
-
Recipient email address
- $subject : string
-
Subject of the email
- $body : string
-
iCalendar body
- $headers : array<string|int, mixed>
-
List of headers