Path

ez components / documentation / api reference / 2009.1rc1 / mail

eZ Components 2009.1rc1

Mail: ezcMailPop3TransportOptions

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

Class: ezcMailPop3TransportOptions

Class containing the options for POP3 transport. [source]
The options from ezcMailTransportOptions are inherited.
Example of how to use POP3 transport options: 
1.  $options = new ezcMailPop3TransportOptions();
2.  $options->ssl = true;
3.  $options->timeout = 3;
4.  $options->authenticationMethod = ezcMailPop3Transport::AUTH_APOP;
5.  
6.  $pop3 = new ezcMailPop3Transport( 'pop3.example.com', null, $options );

Parents

ezcBaseOptions
   |
   --ezcMailTransportOptions
      |
      --ezcMailPop3TransportOptions

Properties

int read/write  $authenticationMethod
Specifies the method to connect to the POP3 transport. The methods supported are ezcMailPop3Transport::AUTH_PLAIN_TEXT and ezcMailPop3Transport::AUTH_APOP.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcMailPop3TransportOptions __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

ezcMailPop3TransportOptions __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, 22 Jun 2009