Docs For Class Rfc822Header

Class Rfc822Header

Description

MIME header class input: header_string or array You must call parseHeader() function after creating object in order to fill object's parameters.

todo: FIXME: there is no constructor function and class should ignore all input args.
since: 1.3.0

Located in /class/mime/Rfc822Header.class.php (line 26)

Variable Summary

array $bcc

array $cc

mixed $content_type

mixed $date

mixed $date_unparsed

mixed $disposition

mixed $dnt

mixed $encoding

array $from

string $in_reply_to

array $mail_followup_to

string $message_id

mixed $mime

mixed $mlist

array $more_headers

integer $priority

string $references

array $reply_to

mixed $sender

string $subject

array $to

string $xmailer

mixed $x_spam_status

Method Summary

object AddressStructure createAddressObject ( &$aStack, &$aComment, &$sEmail, [string $sGroup = ''], array $aStack, array $aComment, string $sEmail)

mixed findAddress (mixed $address, [boolean $recurs = false])

array getAddressTokens (string $address)

array getAddr_a (mixed $arg, [array $excl_arr = array()], [array $arr = array()])

string getAddr_s (mixed $arr, [string $separator = ','], [boolean $encoded = false], [boolean $unconditionally_quote = FALSE])

array getContentType (string $type0, string $type1)

void mlist (string $field, string $value)

mixed parseAddress (string $address, [boolean $ar = false], [ $aAddress = array()], [ $sGroup = ''], [ $sHost = ''], [string $lookup = false], array $addr_ar, string $group, string $host)

void parseContentType (string $value)

void parseDisposition (string $value)

void parseField (string $field, string $value)

void parseHeader (mixed $hdr)

integer parsePriority (string $sValue)

array parseProperties (string $value)

void parseSpamStatus (string $value)

array processParameters (array $aParameters)

string stripComments (string $value)

Variables

array $bcc = array() (line 75)

Bcc header

array $cc = array() (line 70)

Cc header

mixed $content_type = '' (line 98)

mixed $date = -1 (line 31)

Date header

mixed $date_unparsed = '' (line 36)

Original date header as fallback for unparsable dates

mixed $disposition = '' (line 102)

mixed $dnt = '' (line 116)

mixed $encoding = '' (line 120)

array $from = array() (line 46)

From header

string $in_reply_to = '' (line 80)

In-reply-to header

array $mail_followup_to = array() (line 60)

Mail-Followup-To header

string $message_id = '' (line 85)

Message-ID header

mixed $mime = false (line 94)

mixed $mlist = array() (line 124)

array $more_headers = array() (line 135)

Extra header

only needed for constructing headers in delivery class

integer $priority = 3 (line 112)

Priority header

string $references = '' (line 90)

References header

array $reply_to = array() (line 55)

Reply-To header

mixed $sender = '' (line 50)

string $subject = '' (line 41)

Subject header

array $to = array() (line 65)

To header

string $xmailer = '' (line 107)

X-Mailer header

mixed $x_spam_status = array() (line 129)

SpamAssassin 'x-spam-status' header

Methods

createAddressObject (line 467)

return: object

object AddressStructure createAddressObject ( &$aStack, &$aComment, &$sEmail, [string $sGroup = ''], array $aStack, array $aComment, string $sEmail)

array $aStack
array $aComment
string $sEmail
string $sGroup
&$aStack
&$aComment
&$sEmail

findAddress (line 928)

return: array, boolean
since: 1.3.2

mixed findAddress (mixed $address, [boolean $recurs = false])

mixed $address: array or string
boolean $recurs

getAddressTokens (line 334)

array getAddressTokens (string $address)

string $address

getAddr_a (line 886)

function to get the array of addresses out of the header.

array getAddr_a (mixed $arg, [array $excl_arr = array()], [array $arr = array()])

mixed $arg: string or array of strings
array $excl_arr: array of excluded email addresses
array $arr: array of added email addresses

getAddr_s (line 843)

function to get the address strings out of the header.

example1: header->getAddr_s('to'). example2: header->getAddr_s(array('to', 'cc', 'bcc'))

string getAddr_s (mixed $arr, [string $separator = ','], [boolean $encoded = false], [boolean $unconditionally_quote = FALSE])

mixed $arr: string or array of strings
string $separator
boolean $encoded: (since 1.4.0) return encoded or plain text addresses
boolean $unconditionally_quote: (since 1.4.21/1.5.2) When TRUE, always quote the personal part, whether or not it is encoded, otherwise quoting is only added if the personal part is not encoded

getContentType (line 995)

return: media properties
todo: check use of media type arguments

array getContentType (string $type0, string $type1)

string $type0: media type
string $type1: media subtype

mlist (line 764)

Fills mlist array keys in rfc822Header object

void mlist (string $field, string $value)

string $field
string $value

parseAddress (line 520)

recursive function for parsing address strings and storing them in an address stucture object.

personal name: encoded: =?charset?Q|B?string?= quoted: "string" normal: string email : <mailbox@host> : mailbox@host This function is also used for validating addresses returned from compose That's also the reason that the function became a little bit huge

return: array with AddressStructure objects or only one address_structure object.

mixed parseAddress (string $address, [boolean $ar = false], [ $aAddress = array()], [ $sGroup = ''], [ $sHost = ''], [string $lookup = false], array $addr_ar, string $group, string $host)

string $address
boolean $ar: return array instead of only the first element
array $addr_ar: (obsolete) array with parsed addresses
string $group: (obsolete)
string $host: default domainname in case of addresses without a domainname
string $lookup: (since) callback function for lookup of address strings which are probably nicks (without @)
$aAddress
$sGroup
$sHost

parseContentType (line 656)

void parseContentType (string $value)

string $value: content type header

parseDisposition (line 744)

Fills disposition object in rfc822Header object

void parseDisposition (string $value)

string $value

parseField (line 217)

Parse header field according to field type

void parseField (string $field, string $value)

string $field: field name
string $value: field value

parseHeader (line 140)

void parseHeader (mixed $hdr)

mixed $hdr: string or array with message headers

parsePriority (line 636)

Normalise the different Priority headers into a uniform value, namely that of the X-Priority header (1, 3, 5). Supports: Priority, X-Priority, Importance.

X-MS-Mail-Priority is not parsed because it always coincides with one of the other headers.

NOTE: this is actually a duplicate from the function in functions/imap_messages. I'm not sure if it's ok here to call that function?

integer parsePriority (string $sValue)

string $sValue: literal priority name

parseProperties (line 722)

array parseProperties (string $value)

string $value

parseSpamStatus (line 785)

Parses the X-Spam-Status header

void parseSpamStatus (string $value)

string $value

processParameters (line 681)

RFC2184

array processParameters (array $aParameters)

array $aParameters

stripComments (line 170)

string stripComments (string $value)

string $value

Documentation generated on Thu, 20 Jun 2013 04:23:14 +0200 by phpDocumentor 1.4.3