Class SmtpOptions

Summary

Fully Qualified Name: Zend\Mail\Transport\SmtpOptions
Extends: AbstractOptions

Description

Methods

Name Description Defined By
__construct() Constructor AbstractOptions
__get() Get a configuration property AbstractOptions
__isset() Test if a configuration property is null AbstractOptions
__set() Set a configuration property AbstractOptions
__unset() Set a configuration property to NULL AbstractOptions
getConnectionClass() Get connection class SmtpOptions
getConnectionConfig() Get connection configuration array SmtpOptions
getConnectionTimeLimit() SmtpOptions
getHost() Get the host name SmtpOptions
getName() Return the local client hostname SmtpOptions
getPort() Get the port the SMTP server runs on SmtpOptions
setConnectionClass() Set connection class SmtpOptions
setConnectionConfig() Set connection configuration array SmtpOptions
setConnectionTimeLimit() SmtpOptions
setFromArray() Set one or more configuration properties AbstractOptions
setHost() Set the SMTP host SmtpOptions
setName() Set the local client hostname or IP SmtpOptions
setPort() Set the port the SMTP server runs on SmtpOptions
toArray() Cast to array AbstractOptions

Method Details

__construct()

Constructor

Parameter Name Type Description
$options array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name Type Description
$key string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name Type Description
$key string

Returns: bool

__set()

Set a configuration property

Parameter Name Type Description
$key string
$value mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name Type Description
$key string

Returns: void

getConnectionClass()

Get connection class

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

getConnectionConfig()

Get connection configuration array

Returns: array

getConnectionTimeLimit()

Returns: int|null

getHost()

Get the host name

Returns: string

getName()

Return the local client hostname

Returns: string

getPort()

Get the port the SMTP server runs on

Returns: int

setConnectionClass()

Set connection class

Parameter Name Type Description
$connectionClass string the

Returns: \SmtpOptions

setConnectionConfig()

Set connection configuration array

Parameter Name Type Description
$connectionConfig array

Returns: \SmtpOptions

setConnectionTimeLimit()

Parameter Name Type Description
$seconds int|null

Returns: self

setFromArray()

Set one or more configuration properties

Parameter Name Type Description
$options array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setHost()

Set the SMTP host

Parameter Name Type Description
$host string

Returns: \SmtpOptions

setName()

Set the local client hostname or IP

Parameter Name Type Description
$name string

Returns: \SmtpOptions

setPort()

Set the port the SMTP server runs on

Parameter Name Type Description
$port int

Returns: \SmtpOptions

toArray()

Cast to array

Returns: array

Top