Zend_Mail_Transport_File Class Reference

Inheritance diagram for Zend_Mail_Transport_File:

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	defaultCallback ($transport)
Public Member Functions inherited from Zend_Mail_Transport_Abstract
	send (Zend_Mail $mail)

Protected Member Functions
	_sendMail ()
Protected Member Functions inherited from Zend_Mail_Transport_Abstract
	_sendMail ()
	_getHeaders ($boundary)
	_prepareHeaders ($headers)
	_buildBody ()

Protected Attributes
	$_path
	$_callback
Protected Attributes inherited from Zend_Mail_Transport_Abstract
	$_headers = array()
	$_isMultipart = false
	$_mail = false
	$_parts = array()

Additional Inherited Members
Data Fields inherited from Zend_Mail_Transport_Abstract
	$body = ''
	$boundary = ''
	$header = ''
	$recipients = ''
	$EOL = "\r\n"
Static Protected Member Functions inherited from Zend_Mail_Transport_Abstract
static	_formatHeader (&$item, $key, $prefix)

Detailed Description

Definition at line 40 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

array | Zend_Config

$options

OPTIONAL (Default: null)

Returns

void

Definition at line 62 of file File.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            $options = array();
        }

        // Making sure we have some defaults to work with
        if (!isset($options['path'])) {
            $options['path'] = sys_get_temp_dir();
        }
        if (!isset($options['callback'])) {
            $options['callback'] = array($this, 'defaultCallback');
        }

        $this->setOptions($options);
    }

Member Function Documentation

_sendMail()

_sendMail ( )

protected

Saves e-mail message to a file

Returns

void

Exceptions

Zend_Mail_Transport_Exception	on not writable target directory
Zend_Mail_Transport_Exception	on file_put_contents() failure

Definition at line 104 of file File.php.

    {
        $file = $this->_path . DIRECTORY_SEPARATOR . call_user_func($this->_callback, $this);

        if (!is_writable(dirname($file))) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception(sprintf(
                'Target directory "%s" does not exist or is not writable',
                dirname($file)
            ));
        }

        $email = $this->header . $this->EOL . $this->body;

        if (!file_put_contents($file, $email)) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('Unable to send mail');
        }
    }

defaultCallback()

defaultCallback

(

$transport

)

Default callback for generating filenames

Parameters

Zend_Mail_Transport_File

File transport instance

Returns

string

Definition at line 130 of file File.php.

    {
        return 'ZendMail_' . $_SERVER['REQUEST_TIME'] . '_' . mt_rand() . '.tmp';
    }

setOptions()

setOptions

(

array

$options

)

Sets options

Parameters

array

$options

Returns

void

Definition at line 87 of file File.php.

    {
        if (isset($options['path']) && is_dir($options['path'])) {
            $this->_path = $options['path'];
        }
        if (isset($options['callback']) && is_callable($options['callback'])) {
            $this->_callback = $options['callback'];
        }
    }

Field Documentation

$_callback

$_callback

protected

Definition at line 54 of file File.php.

$_path

$_path

protected

Definition at line 47 of file File.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail/Transport/File.php