Swift_Mime_ContentEncoder_PlainContentEncoder Class Reference

Inheritance diagram for Swift_Mime_ContentEncoder_PlainContentEncoder:

Public Member Functions
	__construct ($name, $canonical=false)
	encodeString ($string, $firstLineOffset=0, $maxLineLength=0)
	encodeByteStream (Swift_OutputByteStream $os, Swift_InputByteStream $is, $firstLineOffset=0, $maxLineLength=0)
	getName ()
	charsetChanged ($charset)

Private Member Functions
	_safeWordwrap ($string, $length=75, $le="\r\n")
	_canonicalize ($string)

Private Attributes
	$_name
	$_canonical

Detailed Description

Handles binary/7/8-bit Transfer Encoding in Swift Mailer.

Author

Chris Corbyn

Definition at line 16 of file PlainContentEncoder.php.

Constructor & Destructor Documentation

__construct	(		$name,
			$canonical = false
	)

Creates a new PlainContentEncoder with $name (probably 7bit or 8bit).

Parameters

string	$name
bool	$canonical	If canonicalization transformation should be done.

Definition at line 38 of file PlainContentEncoder.php.

Member Function Documentation

_canonicalize (   $string )

private

Canonicalize string input (fix CRLF).

Parameters

string

$string

Returns

string

Definition at line 154 of file PlainContentEncoder.php.

Referenced by encodeByteStream(), and encodeString().

_safeWordwrap (   $string,   $length = 75,   $le = "\r\n"  )

private

A safer (but weaker) wordwrap for unicode.

Parameters

string	$string
int	$length
string	$le

Returns

string

Definition at line 116 of file PlainContentEncoder.php.

charsetChanged

(

$charset

)

Not used.

Implements Swift_Mime_CharsetObserver.

Definition at line 103 of file PlainContentEncoder.php.

encodeByteStream	(	Swift_OutputByteStream	$os,
		Swift_InputByteStream	$is,
			$firstLineOffset = 0,
			$maxLineLength = 0
	)

Encode stream $in to stream $out.

Parameters

Swift_OutputByteStream	$os
Swift_InputByteStream	$is
int	$firstLineOffset	ignored
int	$maxLineLength	optional, 0 means no wrapping will occur

Implements Swift_Mime_ContentEncoder.

Definition at line 70 of file PlainContentEncoder.php.

References _canonicalize(), Swift_OutputByteStream\read(), and Swift_InputByteStream\write().

encodeString	(		$string,
			$firstLineOffset = 0,
			$maxLineLength = 0
	)

Encode a given string to produce an encoded string.

Parameters

string	$string
int	$firstLineOffset	ignored
int	$maxLineLength	- 0 means no wrapping will occur

Returns

string

Implements Swift_Encoder.

Definition at line 53 of file PlainContentEncoder.php.

References _canonicalize().

getName

(

)

Get the name of this encoding scheme.

Returns

string

Implements Swift_Mime_ContentEncoder.

Definition at line 95 of file PlainContentEncoder.php.

References $_name.

Member Data Documentation

$_canonical

private

Definition at line 30 of file PlainContentEncoder.php.

$_name

private

Definition at line 23 of file PlainContentEncoder.php.

Referenced by getName().