t3lib_readmail Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	getMessage ($mailParts)
	getTextContent ($content)
	getMailBoundaryParts ($boundary, $content)
	getCType ($str)
	analyseReturnError ($c)
	decodeHeaderString ($str)
	extractNameEmail ($str)
	getContentTypeData ($contentTypeStr)
	makeUnixDate ($dateStr)
	getGMToffset ($GMT)
	extractMailHeader ($content, $limit=0)
	fullParse ($content)
Öffentliche Attribute
	$dateAbbrevs
	$serverGMToffsetMinutes = 60

---

Dokumentation der Elementfunktionen

t3lib_readmail::analyseReturnError

(

$

c

)

Analyses the return-mail content for the Dmailer module - used to find what reason there was for rejecting the mail Used by the Dmailer, but not exclusively.

Parameter:

string

message body/text

Rückgabe:

array key/value pairs with analysis result. Eg. "reason", "content", "reason_text", "mailserver" etc.

t3lib_readmail::decodeHeaderString

(

$

str

)

Decodes a header-string with the =?....?= syntax including base64/quoted-printable encoding.

Parameter:

string

A string (encoded or not) from a mail header, like sender name etc.

Rückgabe:

string The input string, but with the parts in =?....?= decoded.

t3lib_readmail::extractMailHeader	(	$	content,
		$	limit = 0
	)

This returns the mail header items in an array with associative keys and the mail body part in another CONTENT field

Parameter:

	string	Raw mail content
	integer	A safety limit that will put a upper length to how many header chars will be processed. Set to zero means that there is no limit. (Uses a simple substr() to limit the amount of mail data to process to avoid run-away)

Rückgabe:

array An array where each key/value pair is a header-key/value pair. The mail BODY is returned in the key 'CONTENT' if $limit is not set!

t3lib_readmail::extractNameEmail

(

$

str

)

Extracts name/email parts from a header field (like 'To:' or 'From:' with name/email mixed up.

Parameter:

string

Value from a header field containing name/email values.

Rückgabe:

array Array with the name and email in. Email is validated, otherwise not set.

t3lib_readmail::fullParse

(

$

content

)

The extended version of the extractMailHeader() which will also parse all the content body into an array and further process the header fields and decode content etc. Returns every part of the mail ready to go.

Parameter:

string

Raw email input.

Rückgabe:

array Multidimensional array with all parts of the message organized nicely. Use t3lib_div::debug() to analyse it visually.

t3lib_readmail::getContentTypeData

(

$

contentTypeStr

)

Returns the data from the 'content-type' field. That is the boundary, charset and mime-type

Parameter:

string

"Content-type-string"

Rückgabe:

array key/value pairs with the result.

t3lib_readmail::getCType

(

$

str

)

Returns Content Type plus more. Obsolete, use fullParse()

Parameter:

string

"ContentType" string with more

Rückgabe:

array parts in key/value pairs

t3lib_readmail::getGMToffset

(

$

GMT

)

Parsing the GMT offset value from a mail timestamp.

Parameter:

string

A string like "+0100" or so.

Rückgabe:

integer Minutes to offset the timestamp private

t3lib_readmail::getMailBoundaryParts	(	$	boundary,
		$	content
	)

Splits the body of a mail into parts based on the boundary string given. Obsolete, use fullParse()

Parameter:

	string	Boundary string used to split the content.
	string	BODY section of a mail

Rückgabe:

array Parts of the mail based on this

t3lib_readmail::getMessage

(

$

mailParts

)

Returns the text content of a mail which has previously been parsed by eg. extractMailHeader() Probably obsolete since the function fullParse() is more advanced and safer to use.

Parameter:

array

Output from extractMailHeader()

Rückgabe:

string The content.

t3lib_readmail::getTextContent

(

$

content

)

Returns the body part of a raw mail message (including headers) Probably obsolete since the function fullParse() is more advanced and safer to use.

Parameter:

string

Raw mail content

Rückgabe:

string Body of message

t3lib_readmail::makeUnixDate

(

$

dateStr

)

Makes a UNIX-date based on the timestamp in the 'Date' header field.

Parameter:

string

String with a timestamp according to email standards.

Rückgabe:

integer The timestamp converted to unix-time in seconds and compensated for GMT/CET ($this->serverGMToffsetMinutes);

---

Dokumentation der Datenelemente

t3lib_readmail::$dateAbbrevs

Initialisierung:

 array(
                'JAN' => 1,
                'FEB' => 2,
                'MAR' => 3,
                'APR' => 4,
                'MAY' => 5,
                'JUN' => 6,
                'JUL' => 7,
                'AUG' => 8,
                'SEP' => 9,
                'OCT' => 10,
                'NOV' => 11,
                'DEC' => 12
        )

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_readmail.php