Path

ez components / documentation / api reference / 2007.2 / mail


Mail

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Source for file imap_set_options.php

Documentation is available at imap_set_options.php

 1. <?php
 2. /**
 3.  * File containing the ezcMailImapSetOptions class.
 4.  *
 5.  * @package Mail
 6.  * @version 1.4
 7.  * @copyright Copyright (C) 2005-2007 eZ systems as. All rights reserved.
 8.  * @license http://ez.no/licenses/new_bsd New BSD License
 9.  */
10.  
11. /**
12.  * Class containing the options for IMAP mail set.
13.  *
14.  * @property bool $uidReferencing 
15.  *            Specifies if the IMAP commands will operate with message unique
16.  *            IDs or with message numbers (default).
17.  *
18.  * @package Mail
19.  * @version 1.4
20.  */
21. class ezcMailImapSetOptions extends ezcBaseOptions
22. {
23.     /**
24.      * Constructs an object with the specified values.
25.      *
26.      * @throws ezcBasePropertyNotFoundException
27.      *          if $options contains a property not defined
28.      * @throws ezcBaseValueException
29.      *          if $options contains a property with a value not allowed
30.      * @param array(string=>mixed) $options 
31.      */
32.     public function __constructarray $options array() )
33.     {
34.         $this->uidReferencing false;
35.  
36.         parent::__construct$options );
37.     }
38.  
39.     /**
40.      * Sets the value of the option $name to $value.
41.      *
42.      * @throws ezcBasePropertyNotFoundException
43.      *          if the property $name is not defined
44.      * @throws ezcBaseValueException
45.      *          if $value is not correct for the property $name
46.      * @param string $name 
47.      * @param mixed $value 
48.      * @ignore
49.      */
50.     public function __set$name$value )
51.     {
52.         switch $name )
53.         {
54.             case 'uidReferencing':
55.                 if !is_bool$value ) )
56.                 {
57.                     throw new ezcBaseValueException$name$value'bool' );
58.                 }
59.                 $this->properties[$name$value;
60.                 break;
61.  
62.             default:
63.                 throw new ezcBasePropertyNotFoundException$name );
64.         }
65.     }
66. }
67. ?>
Last updated: Mon, 17 Dec 2007