API Documentation

Zend/Mime.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_Mime  
Version
$Id: Mime.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mime

Package: Zend\Mime

Support class for MultiPart Mime Messages

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  TYPE_OCTETSTREAM = 'application/octet-stream'
Constant  TYPE_TEXT = 'text/plain'
Constant  TYPE_HTML = 'text/html'
Constant  ENCODING_7BIT = '7bit'
Constant  ENCODING_8BIT = '8bit'
Constant  ENCODING_QUOTEDPRINTABLE = 'quoted-printable'
Constant  ENCODING_BASE64 = 'base64'
Constant  DISPOSITION_ATTACHMENT = 'attachment'
Constant  DISPOSITION_INLINE = 'inline'
Constant  LINELENGTH = 72
Constant  LINEEND = "\n"
Constant  MULTIPART_ALTERNATIVE = 'multipart/alternative'
Constant  MULTIPART_MIXED = 'multipart/mixed'
Constant  MULTIPART_RELATED = 'multipart/related'

Properties

Propertyprotected  $_boundary= ''
Details
Type
Propertyprotected  $makeUnique= '0'
static
Default value0Details
Type
Propertypublic  $qpKeys= 'array( "\x00"'
static
Default valuearray( "\x00"Details
Type
Propertypublic  $qpKeysString= '"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x7F\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF"'
static
Default value"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x7F\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF"Details
Type
Propertypublic  $qpReplaceValues= 'array( "=00"'
static
Default valuearray( "=00"Details
Type

Methods

methodpublic__construct( null|string $boundary = null ) : void

Constructor

Parameters
Name Type Description
$boundary null|string
Details
Access
public  
methodprivate_encodeQuotedPrintable( string $str ) : string
static

Converts a string into quoted printable format.

Parameters
Name Type Description
$str string
Returns
Type Description
string
methodpublicboundary( ) : string

Return a MIME boundary

Returns
Type Description
string
Details
Access
public  
methodpublicboundaryLine( mixed $EOL = self::LINEEND ) : string

Return a MIME boundary line

Parameters
Name Type Description
$EOL mixed

Defaults to {@link LINEEND}

Returns
Type Description
string
Details
Access
public  
methodpublicencode( string $str, string $encoding, string $EOL = self::LINEEND ) : string
static

Encode the given string with the given encoding.

Parameters
Name Type Description
$str string
$encoding string
$EOL string

EOL string; defaults to {@link Zend_Mime::LINEEND}

Returns
Type Description
string
methodpublicencodeBase64( string $str, int $lineLength = self::LINELENGTH, int $lineEnd = self::LINEEND ) : string
static

Encode a given string in base64 encoding and break lines according to the maximum linelength.

Parameters
Name Type Description
$str string
$lineLength int

Defaults to {@link LINELENGTH}

$lineEnd int

Defaults to {@link LINEEND}

Returns
Type Description
string
methodpublicencodeBase64Header( string $str, string $charset, int $lineLength = self::LINELENGTH, int $lineEnd = self::LINEEND ) : string
static

Encode a given string in mail header compatible base64 encoding.

Parameters
Name Type Description
$str string
$charset string
$lineLength int

Defaults to {@link LINELENGTH}

$lineEnd int

Defaults to {@link LINEEND}

Returns
Type Description
string
methodpublicencodeQuotedPrintable( string $str, int $lineLength = self::LINELENGTH, int $lineEnd = self::LINEEND ) : string
static

Encode a given string with the QUOTED_PRINTABLE mechanism and wrap the lines.

Parameters
Name Type Description
$str string
$lineLength int

Defaults to {@link LINELENGTH}

$lineEnd int

Defaults to {@link LINEEND}

Returns
Type Description
string
methodpublicencodeQuotedPrintableHeader( string $str, string $charset, int $lineLength = self::LINELENGTH, int $lineEnd = self::LINEEND ) : string
static

Encode a given string with the QUOTED_PRINTABLE mechanism for Mail Headers.

Mail headers depend on an extended quoted printable algorithm otherwise a range of bugs can occur.

Parameters
Name Type Description
$str string
$charset string
$lineLength int

Defaults to {@link LINELENGTH}

$lineEnd int

Defaults to {@link LINEEND}

Returns
Type Description
string
methodprivategetNextQuotedPrintableToken( string $str ) : string
static

Retrieves the first token from a quoted printable string.

Parameters
Name Type Description
$str string
Returns
Type Description
string
methodpublicisPrintable( string $str ) : boolean
static

Check if the given string is "printable"

Checks that a string contains no unprintable characters. If this returns false, encode the string for secure delivery.

Parameters
Name Type Description
$str string
Returns
Type Description
boolean
methodpublicmimeEnd(  $EOL = self::LINEEND ) : string

Return MIME ending

Parameters
Name Type Description
$EOL
Returns
Type Description
string
Details
Access
public  
Documentation was generated by DocBlox 0.15.1.