Mail/Transport/Smtp.php
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Transport
- Version
- $Id: Smtp.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Mail_Transport_Smtp
SMTP connection object
Loads an instance of Zend_Mail_Protocol_Smtp and forwards smtp transactions
- Parent(s)
- \Zend_Mail_Transport_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $EOL = "\n"EOL character string used by transport
"\n"Details- Type
- string
- Access
- public
string $_auth = Authentication type OPTIONAL
- Type
- string
array $_config = Config options for authentication
- Type
- array
\Zend_Mail_Protocol_Smtp $_connection = Instance of Zend_Mail_Protocol_Smtp
array $_headers = array()
array()Details- Type
- array
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_headers
string $_host = Remote smtp hostname or i.p.
- Type
- string
boolean $_isMultipart = falseMessage is a multipart message
Inherited from: \Zend_Mail_Transport_Abstract::$$_isMultipartfalseDetails- Type
- boolean
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_isMultipart
false|\Zend_Mail $_mail = false
falseDetails- Type
- false | \Zend_Mail
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_mail
string $_name = 'localhost'Local client hostname or i.p.
'localhost'Details- Type
- string
array $_parts = array()
array()Details- Type
- array
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_parts
integer|null $_port = Port number
- Type
- integer | null
string $body = ''
''Details- Type
- string
- Access
- public
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$body
string $boundary = ''
''Details- Type
- string
- Access
- public
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$boundary
string $header = ''
''Details- Type
- string
- Access
- public
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$header
string $recipients = ''
''Details- Type
- string
- Access
- public
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$recipients
Methods
__construct(string $host = '127.0.0.1', array | null $config = array()) : voidConstructor.
| Name | Type | Description |
|---|---|---|
| $host | string | OPTIONAL (Default: 127.0.0.1) |
| $config | array | null | OPTIONAL (Default: null) |
- Todo
- Someone please make this compatible with the SendMail transport class.
__destruct() : voidClass destructor to ensure all open connections are closed
_buildBody() : voidGenerate MIME compliant message from the current configuration
Inherited from: \Zend_Mail_Transport_Abstract::_buildBody()If both a text and HTML body are present, generates a multipart/alternative Zend_Mime_Part containing the headers and contents of each. Otherwise, uses whichever of the text or HTML parts present.
The content part is then prepended to the list of Zend_Mime_Parts for this message.
_formatHeader(string $item, string $key, string $prefix) : voidPrepend header name to header value
Inherited from: \Zend_Mail_Transport_Abstract::_formatHeader()| Name | Type | Description |
|---|---|---|
| $item | string | |
| $key | string | |
| $prefix | string |
- Access
- protected
- Static
_getHeaders(string $boundary) : arrayReturn all mail headers as an array
Inherited from: \Zend_Mail_Transport_Abstract::_getHeaders()If a boundary is given, a multipart header is generated with a Content-Type of either multipart/alternative or multipart/mixed depending on the mail parts present in the Zend_Mail object present.
| Name | Type | Description |
|---|---|---|
| $boundary | string |
| Type | Description |
|---|---|
| array |
_prepareHeaders(array $headers) : voidFormat and fix headers
Some SMTP servers do not strip BCC headers. Most clients do it themselves as do we.
| Name | Type | Description |
|---|---|---|
| $headers | array |
| Exception | Description |
|---|---|
| \Zend_Transport_Exception |
- Access
- protected
_sendMail() : voidSend 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.
- Todo
- Rename this to sendMail, it's a public method...
getConnection() : \Zend_Mail_Protocol | nullGets the connection protocol instance
| Type | Description |
|---|---|
| \Zend_Mail_Protocol | null |
send(\Zend_Mail $mail) : void
| Name | Type | Description |
|---|---|---|
| \Zend_Mail |
| Exception | Description |
|---|---|
| \Zend_Mail_Transport_Exception | if mail is empty |
- Access
- public
setConnection( $connection) : voidSets the connection protocol instance
| Name | Type | Description |
|---|---|---|
| $connection |