Zend Framework » \Zend\Mail\Transport\FileOptions

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 callback used to generate a file name

getCallback() : \Zend\Mail\Transport\callable

Returns

\Zend\Mail\Transport\callable

Get path

getPath() : string

If none is set, uses value from sys_get_temp_dir()

Returns

string

Set callback used to generate a file name

setCallback(\Zend\Mail\Transport\callable $callback) : \Zend\Mail\Transport\FileOptions

Parameters

$callback

\Zend\Mail\Transport\callable

Exceptions

`\Zend\Mail\Exception\InvalidArgumentException`

Returns

\Zend\Mail\Transport\FileOptions

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 path to stored mail files

setPath(string $path) : \Zend\Mail\Transport\FileOptions

Parameters

$path

string

Exceptions

`\Zend\Mail\Exception\InvalidArgumentException`

Returns

\Zend\Mail\Transport\FileOptions

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__

$callback

$callback : \Zend\Mail\Transport\callable

<p>Path to stored mail files</p>

$path : string