Zend Framework » \Zend\Mail\Transport\SmtpOptions

Methods

Constructor

__construct(array | \Traversable | null $options)

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::__construct()

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed

Inherited

see	\Zend\Stdlib\ParameterObject::__get()
inherited_from	\Zend\Stdlib\AbstractOptions::__get()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Returns

mixed

Test if a configuration property is null

__isset(string $key) : bool

Inherited

see	\Zend\Stdlib\ParameterObject::__isset()
inherited_from	\Zend\Stdlib\AbstractOptions::__isset()

Parameters

$key

string

Returns

bool

Set a configuration property

__set(string $key, mixed $value) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__set()
inherited_from	\Zend\Stdlib\AbstractOptions::__set()

Parameters

$key

string

$value

mixed

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Set a configuration property to NULL

__unset(string $key) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__unset()
inherited_from	\Zend\Stdlib\AbstractOptions::__unset()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Get connection class

getConnectionClass() : string

This should be either the class Zend\Mail\Protocol\Smtp or a class extending it -- typically a class in the Zend\Mail\Protocol\Smtp\Auth namespace.

Returns

string

Get connection configuration array

getConnectionConfig() : array

Returns

array

Get the host name

getHost() : string

Returns

string

Return the local client hostname

getName() : string

Returns

string

Get the port the SMTP server runs on

getPort() : int

Returns

int

Set connection class

setConnectionClass(string $connectionClass) : \Zend\Mail\Transport\SmtpOptions

Parameters

$connectionClass

string

the value to be set

Exceptions

`\Zend\Mail\Exception\InvalidArgumentException`

Returns

\Zend\Mail\Transport\SmtpOptions

Set connection configuration array

setConnectionConfig(array $connectionConfig) : \Zend\Mail\Transport\SmtpOptions

Parameters

$connectionConfig

array

Returns

\Zend\Mail\Transport\SmtpOptions

Set one or more configuration properties

setFromArray(array | \Traversable | \Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::setFromArray()

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set the SMTP host

setHost(string $host) : \Zend\Mail\Transport\SmtpOptions

todo	hostname/IP validation

Parameters

$host

string

Returns

\Zend\Mail\Transport\SmtpOptions

Set the local client hostname or IP

setName(string $name) : \Zend\Mail\Transport\SmtpOptions

todo	hostname/IP validation

Parameters

$name

string

Exceptions

`\Zend\Mail\Exception\InvalidArgumentException`

Returns

\Zend\Mail\Transport\SmtpOptions

Set the port the SMTP server runs on

setPort(int $port) : \Zend\Mail\Transport\SmtpOptions

Parameters

$port

int

Exceptions

`\Zend\Mail\Exception\InvalidArgumentException`

Returns

\Zend\Mail\Transport\SmtpOptions

Cast to array

toArray() : array

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::toArray()

Returns

array

Properties

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::$$__strictMode__

$connectionClass

$connectionClass : string

Connection configuration (passed to the underlying Protocol class)

$connectionConfig : array

<p>Remote SMTP hostname or IP</p>

$host : string

<p>Local client hostname</p>

$name : string

$port

$port : int