Path

ez components / documentation / api reference / 2007.1.1 / mail

eZ Components 2007.1.1

Mail: ezcMailSmtpTransportOptions

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

Class: ezcMailSmtpTransportOptions

Class containing the options for SMTP transport. [source]
The options from ezcMailTransportOptions are inherited.

Parents

ezcBaseOptions
   |
   --ezcMailTransportOptions
      |
      --ezcMailSmtpTransportOptions

Properties

array(mixed) read/write  $connectionOptions
Specifies additional options for the connection. Must be in this format: array( 'wrapper_name' => array( 'option_name' => 'value' ) ).
string read/write  $connectionType
Specifies the protocol used to connect to the SMTP server. See the CONNECTION_* constants in the ezcMailSmtpTransport class.
bool read/write  $ssl
This option belongs to ezcMailTransportOptions, but it is not used in SMTP. When trying to set this to true the connectionType option will be set to CONNECTION_SSL value from ezcMailSmtpTransport. When trying to set this to false the connectionType option will be set to CONNECTION_PLAIN value from ezcMailSmtpTransport.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

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

ezcMailSmtpTransportOptions __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: Wed, 28 Nov 2007