API Documentation

Mail/Transport/Sendmail.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Transport  
version
$Id: Sendmail.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Mail_Transport_Sendmail

Class for sending eMails via the PHP internal mail() function

Extends from
\Zend_Mail_Transport_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Transport  

Properties

Propertypublicstring  $EOL= 'PHP_EOL'

EOL character string

Default valuePHP_EOLDetails
Type
string
access
public  
Propertyprotectedstring  $_errstr= ''

error information

Details
Type
string
Propertypublicstring  $parameters= ''

Config options for sendmail parameters

Details
Type
string
Propertypublicstring  $subject= 'null'

Subject

Default valuenullDetails
Type
string
access
public  

Methods

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

Constructor.

Parameters
Name Type Description
$parameters string|array|\Zend_Config

OPTIONAL (Default: null)

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

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

Prepend header name to header value

Inherited from: \Zend_Mail_Transport_Abstract::_formatHeader()
Parameters
Name Type Description
$item string
$key string
$prefix string
Details
access
protected  
static
 
methodprotected_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 {@link $_mail Zend_Mail object} present.

Parameters
Name Type Description
$boundary string
Returns
Type Description
array
methodpublic_handleMailErrors( int $errno, string $errstr, string $errfile = null, string $errline = null, array $errcontext = null ) : true

Temporary error handler for PHP native mail().

Parameters
Name Type Description
$errno int
$errstr string
$errfile string
$errline string
$errcontext array
Returns
Type Description
true
methodprotected_prepareHeaders( array $headers ) : void

Format and fix headers

mail() uses its $to and $subject arguments to set the To: and Subject: headers, respectively. This method strips those out as a sanity check to prevent duplicate header entries.

Parameters
Name Type Description
$headers array
Throws
Exception Description
\Zend_Mail_Transport_Exception
Details
access
protected  
methodpublic_sendMail( ) : void

Send mail using PHP native mail()

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
Throws
Exception Description
\Zend_Mail_Transport_Exception if parameters is set but not a string
\Zend_Mail_Transport_Exception on mail() failure
Details
access
public  
methodpublicsend( \Zend_Mail $mail ) : void

Send a mail using this transport

Inherited from: \Zend_Mail_Transport_Abstract::send()
Parameters
Name Type Description
$mail \Zend_Mail
Throws
Exception Description
\Zend_Mail_Transport_Exception if mail is empty
Details
access
public  
Documentation was generated by DocBlox 0.13.3.