Mail/Transport/File.php
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
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


string $EOL = "\r\n"
"\r\n"
Details- Type
- string
- Access
- public
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$EOL


array $_headers = array()
array()
Details- Type
- array
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_headers


boolean $_isMultipart = false
false
Details- Type
- boolean
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_isMultipart


false|\Zend_Mail $_mail = false
false
Details- Type
- false | \Zend_Mail
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_mail


array $_parts = array()
array()
Details- Type
- array
- Access
- protected
- Inherited_from
- \Zend_Mail_Transport_Abstract::$$_parts


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(array | \Zend_Config $options = null) : void
Constructor
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config | OPTIONAL (Default: null) |


_buildBody() : void
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.


_formatHeader(string $item, string $key, string $prefix) : void
Prepend 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) : array
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.
Name | Type | Description |
---|---|---|
$boundary | string |
Type | Description |
---|---|
array |


_prepareHeaders(mixed $headers) : void
Prepare header string for use in transport
Inherited from: \Zend_Mail_Transport_Abstract::_prepareHeaders()Prepares and generates $header based on the headers provided.
Name | Type | Description |
---|---|---|
$headers | mixed |
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception | if any header lines exceed 998 characters |
- Access
- protected


_sendMail() : void
Saves e-mail message to a file
The requisite information for the email will be found in the following properties:
- $recipients - list of recipients (string)
- $header - message header
- $body - message body
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception | on not writable target directory |
\Zend_Mail_Transport_Exception | on file_put_contents() failure |


defaultCallback(\Zend_Mail_Transport_File $transport) : string
Default callback for generating filenames
Name | Type | Description |
---|---|---|
$transport | \Zend_Mail_Transport_File | File transport instance |
Type | Description |
---|---|
string |


send(\Zend_Mail $mail) : void
Name | Type | Description |
---|---|---|
\Zend_Mail |
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception | if mail is empty |
- Access
- public