Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcMailPop3TransportOptions

Mail::ezcMailPop3TransportOptions

Class ezcMailPop3TransportOptions

Class containing the options for POP3 transport.

The options from ezcMailTransportOptions are inherited.

Example of how to use POP3 transport options:

$options = new ezcMailPop3TransportOptions();
$options->ssl = true;
$options->timeout = 3;
$options->authenticationMethod = ezcMailPop3Transport::AUTH_APOP;
$pop3 = new ezcMailPop3Transport( 'pop3.example.com', null, $options );

Source for this file: /Mail/src/options/pop3_options.php

ezcBaseOptions
   |
   --ezcMailTransportOptions
      |
      --ezcMailPop3TransportOptions

Version:

//autogen//

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)

Exceptions:

Type	Description
`ezcBaseValueException`	if $options contains a property with a value not allowed
`ezcBasePropertyNotFoundException`	if $options contains a property not defined

Redefinition of:

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

Documentation generated by phpDocumentor 1.4.3