Docs For Class Zend

Description

Support class for MultiPart Mime Messages

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

Located in /Mime.php (line 31)

Class Constant Summary

DISPOSITION_ATTACHMENT = 'attachment'

DISPOSITION_INLINE = 'inline'

ENCODING_7BIT = '7bit'

ENCODING_8BIT = '8bit'

ENCODING_BASE64 = 'base64'

ENCODING_QUOTEDPRINTABLE = 'quoted-printable'

LINEEND = "\n"

LINELENGTH = 72

MULTIPART_ALTERNATIVE = 'multipart/alternative'

MULTIPART_MIXED = 'multipart/mixed'

MULTIPART_RELATED = 'multipart/related'

TYPE_HTML = 'text/html'

TYPE_OCTETSTREAM = 'application/octet-stream'

TYPE_TEXT = 'text/plain'

Variable Summary

static mixed $makeUnique

static mixed $qpKeys

static mixed $qpKeysString

static mixed $qpReplaceValues

mixed $_boundary

Method Summary

static string encode (string $str, string $encoding, [string $EOL = self::LINEEND])

static string encodeBase64 (string $str, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

static string encodeBase64Header (string $str, string $charset, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

static string encodeQuotedPrintable (string $str, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

static string encodeQuotedPrintableHeader (string $str, string $charset, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

static boolean isPrintable (string $str)

void __construct ([null|string $boundary = null])

string boundary ()

string boundaryLine ([mixed $EOL = self::LINEEND])

string mimeEnd ([ $EOL = self::LINEEND])

Variables

static mixed $makeUnique = 0 (line 49)

access: protected

static mixed $qpKeys = array(
"\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"
) (line 52)

access: public

static mixed $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" (line 100)

access: public

static mixed $qpReplaceValues = array(
"=00","=01","=02","=03","=04","=05","=06","=07",
"=08","=09","=0A","=0B","=0C","=0D","=0E","=0F",
"=10","=11","=12","=13","=14","=15","=16","=17",
"=18","=19","=1A","=1B","=1C","=1D","=1E","=1F",
"=7F","=80","=81","=82","=83","=84","=85","=86",
"=87","=88","=89","=8A","=8B","=8C","=8D","=8E",
"=8F","=90","=91","=92","=93","=94","=95","=96",
"=97","=98","=99","=9A","=9B","=9C","=9D","=9E",
"=9F","=A0","=A1","=A2","=A3","=A4","=A5","=A6",
"=A7","=A8","=A9","=AA","=AB","=AC","=AD","=AE",
"=AF","=B0","=B1","=B2","=B3","=B4","=B5","=B6",
"=B7","=B8","=B9","=BA","=BB","=BC","=BD","=BE",
"=BF","=C0","=C1","=C2","=C3","=C4","=C5","=C6",
"=C7","=C8","=C9","=CA","=CB","=CC","=CD","=CE",
"=CF","=D0","=D1","=D2","=D3","=D4","=D5","=D6",
"=D7","=D8","=D9","=DA","=DB","=DC","=DD","=DE",
"=DF","=E0","=E1","=E2","=E3","=E4","=E5","=E6",
"=E7","=E8","=E9","=EA","=EB","=EC","=ED","=EE",
"=EF","=F0","=F1","=F2","=F3","=F4","=F5","=F6",
"=F7","=F8","=F9","=FA","=FB","=FC","=FD","=FE",
"=FF"
) (line 76)

access: public

mixed $_boundary (line 48)

access: protected

Methods

static encode (line 315)

Encode the given string with the given encoding.

access: public

static string encode (string $str, string $encoding, [string $EOL = self::LINEEND])

string $str
string $encoding
string $EOL: EOL string; defaults to Zend_Mime::LINEEND

static encodeBase64 (line 283)

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

access: public

static string encodeBase64 (string $str, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

string $str
int $lineLength: Defaults to LINELENGTH
int $lineEnd: Defaults to LINEEND

static encodeBase64Header (line 259)

Encode a given string in mail header compatible base64 encoding.

access: public

static string encodeBase64Header (string $str, string $charset, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

string $str
string $charset
int $lineLength: Defaults to LINELENGTH
int $lineEnd: Defaults to LINEEND

static encodeQuotedPrintable (line 125)

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

access: public

static string encodeQuotedPrintable (string $str, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

string $str
int $lineLength: Defaults to LINELENGTH
int $lineEnd: Defaults to LINEEND

static encodeQuotedPrintableHeader (line 186)

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.

access: public

static string encodeQuotedPrintableHeader (string $str, string $charset, [int $lineLength = self::LINELENGTH], [int $lineEnd = self::LINEEND])

string $str
string $charset
int $lineLength: Defaults to LINELENGTH
int $lineEnd: Defaults to LINEEND

static isPrintable (line 112)

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.

access: public

static boolean isPrintable (string $str)

string $str

Constructor __construct (line 297)

Constructor

access: public

void __construct ([null|string $boundary = null])

null|string $boundary

boundary (line 338)

Return a MIME boundary

access: public

string boundary ()

boundaryLine (line 350)

Return a MIME boundary line

access: public

string boundaryLine ([mixed $EOL = self::LINEEND])

mixed $EOL: Defaults to LINEEND

mimeEnd (line 361)

Return MIME ending

access: public

string mimeEnd ([ $EOL = self::LINEEND])

$EOL

Class Constants

DISPOSITION_ATTACHMENT = 'attachment' (line 40)

DISPOSITION_INLINE = 'inline' (line 41)

ENCODING_7BIT = '7bit' (line 36)

ENCODING_8BIT = '8bit' (line 37)

ENCODING_BASE64 = 'base64' (line 39)

ENCODING_QUOTEDPRINTABLE = 'quoted-printable' (line 38)

LINEEND = "\n" (line 43)

LINELENGTH = 72 (line 42)

MULTIPART_ALTERNATIVE = 'multipart/alternative' (line 44)

MULTIPART_MIXED = 'multipart/mixed' (line 45)

MULTIPART_RELATED = 'multipart/related' (line 46)

TYPE_HTML = 'text/html' (line 35)

TYPE_OCTETSTREAM = 'application/octet-stream' (line 33)

TYPE_TEXT = 'text/plain' (line 34)

Zend_Mime