Support class for MultiPart Mime Messages. More...

Public Member Functions
	__construct ($boundary=null)
	Constructor.

	boundary ()
	Return a MIME boundary.

	boundaryLine ($EOL=self::LINEEND)
	Return a MIME boundary line.

	mimeEnd ($EOL=self::LINEEND)
	Return MIME ending.

Static Public Member Functions
static	isPrintable ($str)
	Check if the given string is "printable".

static	encodeQuotedPrintable ($str, $lineLength=self::LINELENGTH, $lineEnd=self::LINEEND)
	Encode a given string with the QUOTED_PRINTABLE mechanism and wrap the lines.

static	encodeQuotedPrintableHeader ($str, $charset, $lineLength=self::LINELENGTH, $lineEnd=self::LINEEND)
	Encode a given string with the QUOTED_PRINTABLE mechanism for Mail Headers.

static	encodeBase64Header ($str, $charset, $lineLength=self::LINELENGTH, $lineEnd=self::LINEEND)
	Encode a given string in mail header compatible base64 encoding.

static	encodeBase64 ($str, $lineLength=self::LINELENGTH, $lineEnd=self::LINEEND)
	Encode a given string in base64 encoding and break lines according to the maximum linelength.

static	encode ($str, $encoding, $EOL=self::LINEEND)
	Encode the given string with the given encoding.

static	mimeDetectCharset ($str)
	Detect MIME charset.

Public Attributes
const	TYPE_OCTETSTREAM = 'application/octet-stream'

const	TYPE_TEXT = 'text/plain'

const	TYPE_HTML = 'text/html'

const	ENCODING_7BIT = '7bit'

const	ENCODING_8BIT = '8bit'

const	ENCODING_QUOTEDPRINTABLE = 'quoted-printable'

const	ENCODING_BASE64 = 'base64'

const	DISPOSITION_ATTACHMENT = 'attachment'

const	DISPOSITION_INLINE = 'inline'

const	LINELENGTH = 72

const	LINEEND = "\n"

const	MULTIPART_ALTERNATIVE = 'multipart/alternative'

const	MULTIPART_MIXED = 'multipart/mixed'

const	MULTIPART_RELATED = 'multipart/related'

const	CHARSET_REGEX = '#=\?(?P<charset>[\x21\x23-\x26\x2a\x2b\x2d\x5e\5f\60\x7b-\x7ea-zA-Z0-9]+)\?(?P<encoding>[\x21\x23-\x26\x2a\x2b\x2d\x5e\5f\60\x7b-\x7ea-zA-Z0-9]+)\?(?P<text>[\x21-\x3e\x40-\x7e]+)#'

Static Public Attributes
static	$qpKeys

static	$qpReplaceValues

static	$qpKeysString

Protected Attributes
	$boundary

Static Protected Attributes
static	$makeUnique = 0

Detailed Description

Support class for MultiPart Mime Messages.

Constructor & Destructor Documentation

__construct ( $boundary = null )

Constructor.

Parameters

null | string $boundary public

Member Function Documentation

boundary ( )

Return a MIME boundary.

public

Returns: string

boundaryLine ( $EOL = self::LINEEND )

Return a MIME boundary line.

Parameters

string $EOL Defaults to LINEEND public

Returns: string

static encode	(	$str,
		$encoding,
		$EOL = `self::LINEEND`
	)

static

Encode the given string with the given encoding.

Parameters

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

Returns: string

Todo:: 7Bit and 8Bit is currently handled the same way.

static encodeBase64	(	$str,
		$lineLength = `self::LINELENGTH`,
		$lineEnd = `self::LINEEND`
	)

static

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

Parameters

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

Returns: string

static encodeBase64Header	(	$str,
		$charset,
		$lineLength = `self::LINELENGTH`,
		$lineEnd = `self::LINEEND`
	)

static

Encode a given string in mail header compatible base64 encoding.

Parameters

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

Returns: string

static encodeQuotedPrintable	(	$str,
		$lineLength = `self::LINELENGTH`,
		$lineEnd = `self::LINEEND`
	)

static

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

Parameters

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

Returns: string

static encodeQuotedPrintableHeader	(	$str,
		$charset,
		$lineLength = `self::LINELENGTH`,
		$lineEnd = `self::LINEEND`
	)

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

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

Returns: string

static isPrintable ( $str )

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

string $str

Returns: bool

static mimeDetectCharset ( $str )

static

Detect MIME charset.

Extract parts according to https://tools.ietf.org/html/rfc2047#section-2

Parameters

string $str

Returns: string

mimeEnd ( $EOL = self::LINEEND )

Return MIME ending.

Parameters

string $EOL Defaults to LINEEND public

Returns: string

Member Data Documentation

$boundary

protected

$makeUnique = 0

staticprotected

$qpKeys

static

Initial 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"
    ]

$qpKeysString

static

Initial 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"

$qpReplaceValues

static

Initial value:

= [
        "=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"
    ]

const CHARSET_REGEX = '#=\?(?P<charset>[\x21\x23-\x26\x2a\x2b\x2d\x5e\5f\60\x7b-\x7ea-zA-Z0-9]+)\?(?P<encoding>[\x21\x23-\x26\x2a\x2b\x2d\x5e\5f\60\x7b-\x7ea-zA-Z0-9]+)\?(?P<text>[\x21-\x3e\x40-\x7e]+)#'

const DISPOSITION_ATTACHMENT = 'attachment'

const DISPOSITION_INLINE = 'inline'

const ENCODING_7BIT = '7bit'

const ENCODING_8BIT = '8bit'

const ENCODING_BASE64 = 'base64'

const ENCODING_QUOTEDPRINTABLE = 'quoted-printable'

const LINEEND = "\n"

const LINELENGTH = 72

const MULTIPART_ALTERNATIVE = 'multipart/alternative'

const MULTIPART_MIXED = 'multipart/mixed'

const MULTIPART_RELATED = 'multipart/related'

const TYPE_HTML = 'text/html'

const TYPE_OCTETSTREAM = 'application/octet-stream'

const TYPE_TEXT = 'text/plain'

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation