Solutions Open Source

Référence de la classe t3lib_readmail

Liste de tous les membres

Fonctions membres publiques

 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)

Attributs publics

 $dateAbbrevs
 $serverGMToffsetMinutes = 60


Documentation des fonctions membres

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.

Paramètres:
array Output from extractMailHeader()
Renvoie:
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.

Paramètres:
string Raw mail content
Renvoie:
string Body of message

t3lib_readmail::getMailBoundaryParts ( boundary,
content 
)

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

Paramètres:
string Boundary string used to split the content.
string BODY section of a mail
Renvoie:
array Parts of the mail based on this

t3lib_readmail::getCType ( str  ) 

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

Paramètres:
string "ContentType" string with more
Renvoie:
array parts in key/value pairs

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.

Paramètres:
string message body/text
Renvoie:
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.

Paramètres:
string A string (encoded or not) from a mail header, like sender name etc.
Renvoie:
string The input string, but with the parts in =?....?= decoded.

t3lib_readmail::extractNameEmail ( str  ) 

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

Paramètres:
string Value from a header field containing name/email values.
Renvoie:
array Array with the name and email in. Email is validated, otherwise not set.

t3lib_readmail::getContentTypeData ( contentTypeStr  ) 

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

Paramètres:
string "Content-type-string"
Renvoie:
array key/value pairs with the result.

t3lib_readmail::makeUnixDate ( dateStr  ) 

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

Paramètres:
string String with a timestamp according to email standards.
Renvoie:
integer The timestamp converted to unix-time in seconds and compensated for GMT/CET ($this->serverGMToffsetMinutes);

t3lib_readmail::getGMToffset ( GMT  ) 

Parsing the GMT offset value from a mail timestamp.

Paramètres:
string A string like "+0100" or so.
Renvoie:
integer Minutes to offset the timestamp private

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

Paramètres:
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)
Renvoie:
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::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.

Paramètres:
string Raw email input.
Renvoie:
array Multidimensional array with all parts of the message organized nicely. Use t3lib_div::debug() to analyse it visually.


Documentation des données membres

t3lib_readmail::$dateAbbrevs

Valeur initiale :

 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
        )

t3lib_readmail::$serverGMToffsetMinutes = 60


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:28 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3