1: <?php
 2: /**
 3:  * Holds iTip response options.
 4:  *
 5:  * PHP version 5
 6:  *
 7:  * @category Horde
 8:  * @package  Itip
 9:  * @author   Gunnar Wrobel <wrobel@pardus.de>
10:  * @license  http://www.horde.org/licenses/lgpl21 LGPL
11:  * @link     http://pear.horde.org/index.php?package=Itip
12:  */
13: 
14: /**
15:  * Holds iTip response options.
16:  *
17:  * Copyright 2010-2012 Horde LLC (http://www.horde.org/)
18:  *
19:  * See the enclosed file COPYING for license information (LGPL). If you did not
20:  * receive this file, see
21:  * {@link http://www.horde.org/licenses/lgpl21 LGPL}.
22:  *
23:  * @category Horde
24:  * @package  Itip
25:  * @author   Gunnar Wrobel <wrobel@pardus.de>
26:  * @license  http://www.horde.org/licenses/lgpl21 LGPL
27:  * @link     http://pear.horde.org/index.php?package=Itip
28:  */
29: interface Horde_Itip_Response_Options
30: {
31:     /**
32:      * Prepare the iCalendar part of the response object.
33:      *
34:      * @param Horde_Icalendar $ical The iCalendar response object.
35:      *
36:      * @return NULL
37:      */
38:     public function prepareIcalendar(Horde_Icalendar $ical);
39: 
40:     /**
41:      * Prepare the iCalendar MIME part of the response message.
42:      *
43:      * @param Horde_Mime_Part $ics The iCalendar MIME part of the response
44:      *                             message.
45:      *
46:      * @return NULL
47:      */
48:     public function prepareResponseMimeHeaders(Horde_Mime_Headers $headers);
49: 
50:     /**
51:      * Prepare the iCalendar MIME part of the response message.
52:      *
53:      * @param Horde_Mime_Part $ics The iCalendar MIME part of the response
54:      *                             message.
55:      *
56:      * @return NULL
57:      */
58:     public function prepareIcsMimePart(Horde_Mime_Part $ics);
59: 
60:     /**
61:      * Prepare the message MIME part of the response.
62:      *
63:      * @param Horde_Mime_Part $message The message MIME part of the response.
64:      *
65:      * @return NULL
66:      */
67:     public function prepareMessageMimePart(Horde_Mime_Part $message);
68: 
69:     /**
70:      * Get the character set for the response mime parts.
71:      *
72:      * @return string The character set.
73:      */
74:     public function getCharacterSet();
75: 
76:     /**
77:      * Get the product ID of the iCalendar object embedded in the MIME response.
78:      *
79:      * @return string The product ID.
80:      */
81:     public function getProductId();
82: }