Mail/Transport/Abstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Transport  
Version
$Id$  

\Zend_Mail_Transport_Abstract

Package: Zend_Mail\Transport
Abstract for sending eMails through different ways of transport
Children
\Zend_Mail_Transport_Sendmail
\Zend_Mail_Transport_Smtp
\Zend_Mail_Transport_File
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertypublicstring $EOL = "\r\n"
EOL character string used by transport
Default value"\r\n"Details
Type
string
Access
public  
>VPropertyprotectedarray $_headers = array()
Array of message headers
Default valuearray()Details
Type
array
Access
protected  
>VPropertyprotectedboolean $_isMultipart = false
Message is a multipart message
Default valuefalseDetails
Type
boolean
Access
protected  
>VPropertyprotectedfalse|\Zend_Mail $_mail = false
Zend_Mail object
Default valuefalseDetails
Type
false | \Zend_Mail
Access
protected  
>VPropertyprotectedarray $_parts = array()
Array of message parts
Default valuearray()Details
Type
array
Access
protected  
>VPropertypublicstring $body = ''
Mail body
Default value''Details
Type
string
Access
public  
>VPropertypublicstring $boundary = ''
MIME boundary
Default value''Details
Type
string
Access
public  
>VPropertypublicstring $header = ''
Mail header string
Default value''Details
Type
string
Access
public  
>VPropertypublicstring $recipients = ''
Recipients string
Default value''Details
Type
string
Access
public  

Methods

methodprotected_buildBody() : void

Generate MIME compliant message from the current configuration

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.
methodprotected_formatHeader(string $item, string $key, string $prefix) : void
static

Prepend header name to header value

Parameters
NameTypeDescription
$itemstring
$keystring
$prefixstring
Details
Access
protected  
Static
 
methodprotected_getHeaders(string $boundary) : array

Return all mail headers as an array

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 {@link $_mail Zend_Mail object} present.
Parameters
NameTypeDescription
$boundarystring
Returns
TypeDescription
array
methodprotected_prepareHeaders(mixed $headers) : void

Prepare header string for use in transport

Prepares and generates {@link $header} based on the headers provided.
Parameters
NameTypeDescription
$headersmixed
Throws
ExceptionDescription
\Zend_Mail_Transport_Exceptionif any header lines exceed 998 characters
Details
Access
protected  
methodprotected_sendMail() : void
abstract

Send an email independent from the used transport

The requisite information for the email will be found in the following properties: - {@link $recipients} - list of recipients (string) - {@link $header} - message header - {@link $body} - message body
methodpublicsend(\Zend_Mail $mail) : void

Send a mail using this transport

Parameters
NameTypeDescription
$mail\Zend_Mail
Throws
ExceptionDescription
\Zend_Mail_Transport_Exceptionif mail is empty
Details
Access
public  
Documentation was generated by phpDocumentor 2.2.0 .