Path

ez components / documentation / api reference / 2007.2 / mail

Mail: ezcMailImapTransportOptions

[ Tutorial ] [ Display example ] [ Mail listing example ] [ Rfcs ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailImapTransportOptions

Class containing the options for IMAP transport. [source]
The options from ezcMailTransportOptions are inherited.
Example of how to use IMAP transport options: 
1.  $options = new ezcMailImapTransportOptions();
2.  $options->ssl = true;
3.  $options->timeout = 3;
4.  $options->uidReferencing = true;
5.  
6.  $imap = new ezcMailImapTransport( 'imap.example.com', null, $options );

Parents

ezcBaseOptions
   |
   --ezcMailTransportOptions
      |
      --ezcMailImapTransportOptions

Properties

bool read/write  $uidReferencing
Specifies if the IMAP commands will operate with message unique IDs or with message numbers (default).

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcMailImapTransportOptions __construct( [$options = array()] )
Constructs an object with the specified values.

Inherited Methods

From ezcMailTransportOptions :
public ezcMailTransportOptions ezcMailTransportOptions::__construct()
Constructs an object with the specified values.
From ezcBaseOptions :
public ezcBaseOptions ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.

Methods

__construct

ezcMailImapTransportOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed)  

Throws

ClassDescription
ezcBasePropertyNotFoundException if $options contains a property not defined
ezcBaseValueException if $options contains a property with a value not allowed

Redefinition of

Method Description
ezcMailTransportOptions::__construct() Constructs an object with the specified values.

Last updated: Mon, 17 Dec 2007