API Documentation

Mail/Transport/Smtp.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Transport
version
$Id: Smtp.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Mail_Transport_Smtp

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Mail_Transport_Smtp
jump to top

Extends from
Zend_Mail_Transport_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Transport
Properties
$EOL
$_host
$_port
$_name
$_auth
$_config
$_connection
Methods
__construct
__destruct
setConnection
getConnection
_sendMail
_prepareHeaders

Description

SMTP connection object

Loads an instance of Zend_Mail_Protocol_Smtp and forwards smtp transactions

Properties

$EOL
jump to class

string $EOL = '\n'

EOL character string used by transport

Details

$EOL
string
visibility
public
default
\n
final
false
static
false
access
public

$_auth
jump to class

string $_auth = ''

Authentication type OPTIONAL

Details

$_auth
string
visibility
protected
default
final
false
static
false

$_config
jump to class

array $_config = ''

Config options for authentication

Details

$_config
array
visibility
protected
default
final
false
static
false

$_connection
jump to class

Zend_Mail_Protocol_Smtp $_connection = ''

Instance of Zend_Mail_Protocol_Smtp

Details

$_connection
Zend_Mail_Protocol_Smtp
visibility
protected
default
final
false
static
false

$_host
jump to class

string $_host = ''

Remote smtp hostname or i.p.

Details

$_host
string
visibility
protected
default
final
false
static
false

$_name
jump to class

string $_name = 'localhost'

Local client hostname or i.p.

Details

$_name
string
visibility
protected
default
localhost
final
false
static
false

$_port
jump to class

integer|null $_port = ''

Port number

Details

$_port
integer|null
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $host = 127.0.0.1, array|null $config = array ) : void

Constructor.

Arguments
$host
string
OPTIONAL (Default: 127.0.0.1)
$config
arraynull
OPTIONAL (Default: null)
Details
visibility
public
final
false
static
false
todo
Someone please make this compatible with the SendMail transport class.

__destruct
jump to class

__destruct( ) : void

Class destructor to ensure all open connections are closed

Details
visibility
public
final
false
static
false

_prepareHeaders
jump to class

_prepareHeaders( array $headers ) : void

Format and fix headers

Some SMTP servers do not strip BCC headers. Most clients do it themselves as do we.

Arguments
$headers
array
Details
visibility
protected
final
false
static
false
access
protected
throws

_sendMail
jump to class

_sendMail( ) : void

Send an email via the SMTP connection protocol

The connection via the protocol adapter is made just-in-time to allow a developer to add a custom adapter if required before mail is sent.

Details
visibility
public
final
false
static
false
todo
Rename this to sendMail, it's a public method...

getConnection
jump to class

getConnection( ) : Zend_Mail_Protocol|null

Gets the connection protocol instance

Output
Zend_Mail_Protocol|null
Details
visibility
public
final
false
static
false

setConnection
jump to class

setConnection(  $connection ) : void

Sets the connection protocol instance

Arguments
$connection
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.