Support class for MultiPart Mime Messages

 Methods

Constructor

__construct(null | string $boundary) 

access public

Parameters

$boundary

nullstring

Return a MIME boundary

boundary() : string

access public

Returns

string

Return a MIME boundary line

boundaryLine(string $EOL) : 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) : string

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, int $lineLength, string $lineEnd) : string

Parameters

$str

string

$lineLength

int

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, int $lineLength, string $lineEnd) : string

Parameters

$str

string

$charset

string

$lineLength

int

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, int $lineLength, string $lineEnd) : string

Parameters

$str

string

$lineLength

int

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, int $lineLength, string $lineEnd) : string

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

Parameters

$str

string

$charset

string

$lineLength

int

Defaults to {@link LINELENGTH}

$lineEnd

string

Defaults to {@link LINEEND}

Returns

string

Check if the given string is "printable"

isPrintable(string $str) : bool

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

Parameters

$str

string

Returns

bool

Return MIME ending

mimeEnd(string $EOL) : string

access public

Parameters

$EOL

string

Defaults to {@link LINEEND}

Returns

string

Converts a string into quoted printable format.

_encodeQuotedPrintable(string $str) : string

Parameters

$str

string

Returns

string

Retrieves the first token from a quoted printable string.

getNextQuotedPrintableToken(string $str) : string

Parameters

$str

string

Returns

string

 Properties

 

$qpKeys

$qpKeys 

 

$qpKeysString

$qpKeysString 

 

$qpReplaceValues

$qpReplaceValues 

 

$boundary

$boundary 

 

$makeUnique

$makeUnique 

 Constants

 

DISPOSITION_ATTACHMENT

DISPOSITION_ATTACHMENT 

 

DISPOSITION_INLINE

DISPOSITION_INLINE 

 

ENCODING_7BIT

ENCODING_7BIT 

 

ENCODING_8BIT

ENCODING_8BIT 

 

ENCODING_BASE64

ENCODING_BASE64 

 

ENCODING_QUOTEDPRINTABLE

ENCODING_QUOTEDPRINTABLE 

 

LINEEND

LINEEND 

 

LINELENGTH

LINELENGTH 

 

MULTIPART_ALTERNATIVE

MULTIPART_ALTERNATIVE 

 

MULTIPART_MIXED

MULTIPART_MIXED 

   

TYPE_HTML

TYPE_HTML 

 

TYPE_OCTETSTREAM

TYPE_OCTETSTREAM 

 

TYPE_TEXT

TYPE_TEXT