API Documentation

Zend/Mail/Transport/File.php

Show: inherited
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

Propertyprotectedstring|array  $_callback= ''

Callback function generating a file name

Details
Type
stringarray
Propertyprotectedstring  $_path= ''

Target directory for saving sent email messages

Details
Type
string

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config

OPTIONAL (Default: null)

methodprotected_sendMail( ) : void

Saves e-mail message to a file

Throws
Exception Description
\Zend_Mail_Transport_Exception on not writable target directory
\Zend_Mail_Transport_Exception on file_put_contents() failure
methodpublicdefaultCallback( \Zend_Mail_Transport_File $transport ) : string

Default callback for generating filenames

Parameters
Name Type Description
$transport \Zend_Mail_Transport_File

File transport instance

Returns
Type Description
string
methodpublicsetOptions( array $options ) : void

Sets options

Parameters
Name Type Description
$options array
Documentation was generated by DocBlox 0.15.1.