Mail/Transport/File.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 license@zend.com 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$  

\Zend_Mail_Transport_File

Package: Zend\Mail\Transport
File transport

Class for saving outgoing emails in filesystem

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

>VPropertypublicstring $EOL = "\r\n"
inherited
EOL character string used by transport
Inherited from: \Zend_Mail_Transport_Abstract::$$EOL
Default value"\r\n"Details
Type
string
Access
public  
Inherited_from
\Zend_Mail_Transport_Abstract::$$EOL  
>VPropertyprotectedstring|array $_callback
Callback function generating a file name
Details
Type
string | array
>VPropertyprotectedarray $_headers = array()
inherited
Array of message headers
Inherited from: \Zend_Mail_Transport_Abstract::$$_headers
Default valuearray()Details
Type
array
Access
protected  
Inherited_from
\Zend_Mail_Transport_Abstract::$$_headers  
>VPropertyprotectedboolean $_isMultipart = false
inherited
Message is a multipart message
Inherited from: \Zend_Mail_Transport_Abstract::$$_isMultipart
Default valuefalseDetails
Type
boolean
Access
protected  
Inherited_from
\Zend_Mail_Transport_Abstract::$$_isMultipart  
>VPropertyprotectedfalse|\Zend_Mail $_mail = false
inherited
Zend_Mail object
Inherited from: \Zend_Mail_Transport_Abstract::$$_mail
Default valuefalseDetails
Type
false | \Zend_Mail
Access
protected  
Inherited_from
\Zend_Mail_Transport_Abstract::$$_mail  
>VPropertyprotectedarray $_parts = array()
inherited
Array of message parts
Inherited from: \Zend_Mail_Transport_Abstract::$$_parts
Default valuearray()Details
Type
array
Access
protected  
Inherited_from
\Zend_Mail_Transport_Abstract::$$_parts  
>VPropertyprotectedstring $_path
Target directory for saving sent email messages
Details
Type
string
>VPropertypublicstring $body = ''
inherited
Mail body
Inherited from: \Zend_Mail_Transport_Abstract::$$body
Default value''Details
Type
string
Access
public  
Inherited_from
\Zend_Mail_Transport_Abstract::$$body  
>VPropertypublicstring $boundary = ''
inherited
MIME boundary
Inherited from: \Zend_Mail_Transport_Abstract::$$boundary
Default value''Details
Type
string
Access
public  
Inherited_from
\Zend_Mail_Transport_Abstract::$$boundary  
>VPropertypublicstring $header = ''
inherited
Mail header string
Inherited from: \Zend_Mail_Transport_Abstract::$$header
Default value''Details
Type
string
Access
public  
Inherited_from
\Zend_Mail_Transport_Abstract::$$header  
>VPropertypublicstring $recipients = ''
inherited
Recipients string
Inherited from: \Zend_Mail_Transport_Abstract::$$recipients
Default value''Details
Type
string
Access
public  
Inherited_from
\Zend_Mail_Transport_Abstract::$$recipients  

Methods

methodpublic__construct(array | \Zend_Config $options = null) : void

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config

OPTIONAL (Default: null)

methodprotected_buildBody() : void
inherited

Generate 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.

methodprotected_formatHeader(string $item, string $key, string $prefix) : void
staticinherited

Prepend header name to header value

Inherited from: \Zend_Mail_Transport_Abstract::_formatHeader()
Parameters
NameTypeDescription
$itemstring
$keystring
$prefixstring
Details
Access
protected  
Static
 
methodprotected_getHeaders(string $boundary) : array
inherited

Return 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.

Parameters
NameTypeDescription
$boundarystring
Returns
TypeDescription
array
methodprotected_prepareHeaders(mixed $headers) : void
inherited

Prepare header string for use in transport

Inherited from: \Zend_Mail_Transport_Abstract::_prepareHeaders()

Prepares and generates $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

Saves e-mail message to a file

The requisite information for the email will be found in the following properties:

Throws
ExceptionDescription
\Zend_Mail_Transport_Exceptionon not writable target directory
\Zend_Mail_Transport_Exceptionon file_put_contents() failure
methodpublicdefaultCallback(\Zend_Mail_Transport_File $transport) : string

Default callback for generating filenames

Parameters
NameTypeDescription
$transport\Zend_Mail_Transport_File

File transport instance

Returns
TypeDescription
string
methodpublicsend(\Zend_Mail $mail) : void
inherited

Send a mail using this transport

Inherited from: \Zend_Mail_Transport_Abstract::send()
Parameters
NameTypeDescription
$mail\Zend_Mail
Throws
ExceptionDescription
\Zend_Mail_Transport_Exceptionif mail is empty
Details
Access
public  
methodpublicsetOptions(array $options) : void

Sets options

Parameters
NameTypeDescription
$optionsarray
Documentation was generated by phpDocumentor 2.0.0a12.