Mime.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mime
version: $Id: Mime.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Mime

Description

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.

Zend_Mime
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mime
Constants: TYPE_OCTETSTREAM; TYPE_TEXT; TYPE_HTML; ENCODING_7BIT; ENCODING_8BIT; ENCODING_QUOTEDPRINTABLE; ENCODING_BASE64; DISPOSITION_ATTACHMENT; DISPOSITION_INLINE; LINELENGTH; LINEEND; MULTIPART_ALTERNATIVE; MULTIPART_MIXED; MULTIPART_RELATED
Properties: $_boundary; $makeUnique; $qpKeys; $qpReplaceValues; $qpKeysString
Methods: isPrintable; encodeQuotedPrintable; _encodeQuotedPrintable; encodeQuotedPrintableHeader; getNextQuotedPrintableToken; encodeBase64Header; encodeBase64; __construct; encode; boundary; boundaryLine; mimeEnd

Description

Support class for MultiPart Mime Messages

Constants

TYPE_OCTETSTREAM
jump to class

 TYPE_OCTETSTREAM = 'application/octet-stream'

Details

value: application/octet-stream

TYPE_TEXT
jump to class

 TYPE_TEXT = 'text/plain'

Details

value: text/plain

TYPE_HTML
jump to class

 TYPE_HTML = 'text/html'

Details

value: text/html

ENCODING_7BIT
jump to class

 ENCODING_7BIT = '7bit'

Details

value: 7bit

ENCODING_8BIT
jump to class

 ENCODING_8BIT = '8bit'

Details

value: 8bit

ENCODING_QUOTEDPRINTABLE
jump to class

 ENCODING_QUOTEDPRINTABLE = 'quoted-printable'

Details

value: quoted-printable

ENCODING_BASE64
jump to class

 ENCODING_BASE64 = 'base64'

Details

value: base64

DISPOSITION_ATTACHMENT
jump to class

 DISPOSITION_ATTACHMENT = 'attachment'

Details

value: attachment

DISPOSITION_INLINE
jump to class

 DISPOSITION_INLINE = 'inline'

Details

value: inline

LINELENGTH
jump to class

 LINELENGTH = '72'

Details

value: 72

LINEEND
jump to class

 LINEEND = '\n'

Details

value: \n

MULTIPART_ALTERNATIVE
jump to class

 MULTIPART_ALTERNATIVE = 'multipart/alternative'

Details

value: multipart/alternative

MULTIPART_MIXED
jump to class

 MULTIPART_MIXED = 'multipart/mixed'

Details

value: multipart/mixed

MULTIPART_RELATED
jump to class

 MULTIPART_RELATED = 'multipart/related'

Details

value: multipart/related

Properties

$_boundary
jump to class

$_boundary = ''

Details

visibility: protected
default
final: false
static: false

$makeUnique
jump to class

$makeUnique = '0'

Details

visibility: protected
default: 0
final: false
static: true

$qpKeys
jump to class

$qpKeys = 'array'

Details

visibility: public
default: array
final: false
static: true

$qpKeysString
jump to class

 $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'

Details

visibility: public
default: \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
final: false
static: true

$qpReplaceValues
jump to class

$qpReplaceValues = 'array'

Details

visibility: public
default: array
final: false
static: true

Methods

__construct
jump to class

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

Constructor

Arguments

$boundary: nullstring

Details

visibility: public
final: false
static: false
access: public

_encodeQuotedPrintable
jump to class

_encodeQuotedPrintable(
          string $str
          )
        
        :
        string

Converts a string into quoted printable format.

Arguments

$str: string

Output

string

Details

visibility: private
final: false
static: true

boundary
jump to class

boundary(
          
          )
        
        :
        string

Return a MIME boundary

Output

string

Details

visibility: public
final: false
static: false
access: public

boundaryLine
jump to class

boundaryLine(
          mixed $EOL
              =
              self
          )
        
        :
        string

Return a MIME boundary line

Arguments

$EOL: mixed
Defaults to {@link LINEEND}

Output

string

Details

visibility: public
final: false
static: false
access: public

encode
jump to class

encode(
          string $str, string $encoding, string $EOL
              =
              self
          )
        
        :
        string

Encode the given string with the given encoding.

Arguments

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

Output

string

Details

visibility: public
final: false
static: true

encodeBase64
jump to class

encodeBase64(
          string $str, int $lineLength
              =
              self, int $lineEnd
              =
              self
          )
        
        :
        string

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

Arguments

$str: string
$lineLength: int
Defaults to {@link LINELENGTH}
$lineEnd: int
Defaults to {@link LINEEND}

Output

string

Details

visibility: public
final: false
static: true

encodeBase64Header
jump to class

encodeBase64Header(
          string $str, string $charset, int $lineLength
              =
              self, int $lineEnd
              =
              self
          )
        
        :
        string

Encode a given string in mail header compatible base64 encoding.

Arguments

$str: string
$charset: string
$lineLength: int
Defaults to {@link LINELENGTH}
$lineEnd: int
Defaults to {@link LINEEND}

Output

string

Details

visibility: public
final: false
static: true

encodeQuotedPrintable
jump to class

encodeQuotedPrintable(
          string $str, int $lineLength
              =
              self, int $lineEnd
              =
              self
          )
        
        :
        string

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

Arguments

$str: string
$lineLength: int
Defaults to {@link LINELENGTH}
$lineEnd: int
Defaults to {@link LINEEND}

Output

string

Details

visibility: public
final: false
static: true

encodeQuotedPrintableHeader
jump to class

encodeQuotedPrintableHeader(
          string $str, string $charset, int $lineLength
              =
              self, int $lineEnd
              =
              self
          )
        
        :
        string

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.

Arguments

$str: string
$charset: string
$lineLength: int
Defaults to {@link LINELENGTH}
$lineEnd: int
Defaults to {@link LINEEND}

Output

string

Details

visibility: public
final: false
static: true

getNextQuotedPrintableToken
jump to class

getNextQuotedPrintableToken(
          string $str
          )
        
        :
        string

Retrieves the first token from a quoted printable string.

Arguments

$str: string

Output

string

Details

visibility: private
final: false
static: true

isPrintable
jump to class

isPrintable(
          string $str
          )
        
        :
        boolean

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.

Arguments

$str: string

Output

boolean

Details

visibility: public
final: false
static: true

mimeEnd
jump to class

mimeEnd(
           $EOL
              =
              self
          )
        
        :
        string

Return MIME ending

Arguments

$EOL

Output

string

Details

visibility: public
final: false
static: false
access: public

API Documentation

Mime.php

Description

Zend_Mimejump to top

Description

Constants

TYPE_OCTETSTREAMjump to class

Details

TYPE_TEXTjump to class

Details

TYPE_HTMLjump to class

Details

ENCODING_7BITjump to class

Details

ENCODING_8BITjump to class

Details

ENCODING_QUOTEDPRINTABLEjump to class

Details

ENCODING_BASE64jump to class

Details

DISPOSITION_ATTACHMENTjump to class

Details

DISPOSITION_INLINEjump to class

Details

LINELENGTHjump to class

Details

LINEENDjump to class

Details

MULTIPART_ALTERNATIVEjump to class

Details

MULTIPART_MIXEDjump to class

Details

MULTIPART_RELATEDjump to class

Details

Properties

$_boundaryjump to class

Details

$makeUniquejump to class

Details

$qpKeysjump to class

Details

$qpKeysStringjump to class

Details

$qpReplaceValuesjump to class

Details

Methods

__constructjump to class

Arguments

Details

_encodeQuotedPrintablejump to class

Arguments

Output

Details

boundaryjump to class

Output

Details

boundaryLinejump to class

Arguments

Output

Details

encodejump to class

Arguments

Output

Details

encodeBase64jump to class

Arguments

Output

Details

encodeBase64Headerjump to class

Arguments

Output

Details

encodeQuotedPrintablejump to class

Arguments

Output

Details

encodeQuotedPrintableHeaderjump to class

Arguments

Output

Details

Zend_Mime
jump to top

TYPE_OCTETSTREAM
jump to class

TYPE_TEXT
jump to class

TYPE_HTML
jump to class

ENCODING_7BIT
jump to class

ENCODING_8BIT
jump to class

ENCODING_QUOTEDPRINTABLE
jump to class

ENCODING_BASE64
jump to class

DISPOSITION_ATTACHMENT
jump to class

DISPOSITION_INLINE
jump to class

LINELENGTH
jump to class

LINEEND
jump to class

MULTIPART_ALTERNATIVE
jump to class

MULTIPART_MIXED
jump to class

MULTIPART_RELATED
jump to class

$_boundary
jump to class

$makeUnique
jump to class

$qpKeys
jump to class

$qpKeysString
jump to class

$qpReplaceValues
jump to class

__construct
jump to class

_encodeQuotedPrintable
jump to class

boundary
jump to class

boundaryLine
jump to class

encode
jump to class

encodeBase64
jump to class

encodeBase64Header
jump to class

encodeQuotedPrintable
jump to class

encodeQuotedPrintableHeader
jump to class

getNextQuotedPrintableToken
jump to class

isPrintable
jump to class

mimeEnd
jump to class