Support class for MultiPart Mime Messages

package Default

 Methods

Constructor

__construct(null|string $boundary = null
access public

Parameters

$boundary

nullstring

Return a MIME boundary

boundary() : string
access public

Returns

string

Return a MIME boundary line

boundaryLine(string $EOL = self::LINEEND) : string
access public

Parameters

$EOL

string

Defaults to {@link LINEEND}

Returns

string

Encode the given string with the given encoding.

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

Parameters

$str

string

$encoding

string

$EOL

string

EOL string; defaults to {@link LINEEND}

Returns

string

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

encodeBase64(string $str, integer $lineLength = self::LINELENGTH, string $lineEnd = self::LINEEND) : string
Static

Parameters

$str

string

$lineLength

integer

Defaults to {@link LINELENGTH}

$lineEnd

string

Defaults to {@link LINEEND}

Returns

string

Encode a given string in mail header compatible base64 encoding.

encodeBase64Header(string $str, string $charset, integer $lineLength = self::LINELENGTH, string $lineEnd = self::LINEEND) : string
Static

Parameters

$str

string

$charset

string

$lineLength

integer

Defaults to {@link LINELENGTH}

$lineEnd

string

Defaults to {@link LINEEND}

Returns

string

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

encodeQuotedPrintable(string $str, integer $lineLength = self::LINELENGTH, string $lineEnd = self::LINEEND) : string
Static

Parameters

$str

string

$lineLength

integer

Defaults to {@link LINELENGTH}

$lineEnd

string

Defaults to {@link LINEEND}

Returns

string

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

encodeQuotedPrintableHeader(string $str, string $charset, integer $lineLength = self::LINELENGTH, string $lineEnd = self::LINEEND) : string
Static

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

Parameters

$str

string

$charset

string

$lineLength

integer

Defaults to {@link LINELENGTH}

$lineEnd

string

Defaults to {@link LINEEND}

Returns

string

Check if the given string is "printable"

isPrintable(string $str) : boolean
Static

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

Parameters

$str

string

Returns

boolean

Return MIME ending

mimeEnd(string $EOL = self::LINEEND) : string
access public

Parameters

$EOL

string

Defaults to {@link LINEEND}

Returns

string

Converts a string into quoted printable format.

_encodeQuotedPrintable(string $str) : string
Static

Parameters

$str

string

Returns

string

Retrieves the first token from a quoted printable string.

getNextQuotedPrintableToken(string $str) : string
Static

Parameters

$str

string

Returns

string

 Properties

 

$qpKeys

$qpKeys 

Default

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")
Static
 

$qpKeysString

$qpKeysString 

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

$qpReplaceValues

$qpReplaceValues 

Default

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")
Static
 

$boundary

$boundary 

Default

 

$makeUnique

$makeUnique 

Default

0
Static

 Constants

 

DISPOSITION_ATTACHMENT

DISPOSITION_ATTACHMENT = 'attachment' 
 

DISPOSITION_INLINE

DISPOSITION_INLINE = 'inline' 
 

ENCODING_7BIT

ENCODING_7BIT = '7bit' 
 

ENCODING_8BIT

ENCODING_8BIT = '8bit' 
 

ENCODING_BASE64

ENCODING_BASE64 = 'base64' 
 

ENCODING_QUOTEDPRINTABLE

ENCODING_QUOTEDPRINTABLE = 'quoted-printable' 
 

LINEEND

LINEEND = "\n" 
 

LINELENGTH

LINELENGTH = 72 
 

MULTIPART_ALTERNATIVE

MULTIPART_ALTERNATIVE = 'multipart/alternative' 
 

MULTIPART_MIXED

MULTIPART_MIXED = 'multipart/mixed' 
   

TYPE_HTML

TYPE_HTML = 'text/html' 
 

TYPE_OCTETSTREAM

TYPE_OCTETSTREAM = 'application/octet-stream' 
 

TYPE_TEXT

TYPE_TEXT = 'text/plain'