[ Index ]
 

Code source de Horde 3.1.3

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/Horde/MIME/ -> Headers.php (sommaire)

The description of Horde to use in the 'User-Agent:' header.

Poids: 713 lignes (21 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

MIME_Headers:: (31 méthodes):
  MIME_Headers()
  _getStream()
  getHeaderText()
  getAllHeaders()
  getHeaderObject()
  buildHeaders()
  buildFlags()
  toArray()
  toString()
  addReceivedHeader()
  addMessageIdHeader()
  addResentHeaders()
  addDeliveryReceiptHeaders()
  addAgentHeader()
  getAgentHeader()
  addHeader()
  removeHeader()
  setValue()
  getString()
  getValue()
  alteredHeader()
  setValueByFunction()
  addMIMEHeaders()
  getAddressesFromObject()
  listHeaders()
  listHeadersExist()
  setEOL()
  getEOL()
  getFlag()
  getFromAddress()
  getOb()


Classe: MIME_Headers  - X-Ref

The MIME_Headers:: class contains generic functions related to
handling the headers of mail messages.

The default character set to use for headers should be defined in the
variable $GLOBALS['mime_headers']['default_charset'] (defaults to US-ASCII
per RFC 2045).

$Horde: framework/MIME/MIME/Headers.php,v 1.29.10.20 2006/04/15 17:24:19 slusarz Exp $

Copyright 2002-2006 Michael Slusarz <slusarz@bigworm.colorado.edu>

See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

MIME_Headers($index = null)   X-Ref
Constructor.

param: integer $index  The message index to parse headers.

_getStream()   X-Ref
Returns a reference to a currently open IMAP stream.
THIS VALUE SHOULD BE OVERRIDEN BY ALL SUBCLASSES.

return: resource  An IMAP resource stream.

getHeaderText()   X-Ref
Return the full list of headers from the imap_fetchheader() function.

return: string  See imap_fetchheader().

getAllHeaders($decode = true)   X-Ref
Return the full list of headers.

param: boolean $decode  Decode the headers?
return: array  See MIME_Structure::parseMIMEHeaders().

getHeaderObject()   X-Ref
Return the header object from imap_headerinfo().

return: stdClass  See imap_headerinfo().

buildHeaders($decode = true)   X-Ref
Build the header array.

param: boolean $decode  MIME decode the headers?

buildFlags()   X-Ref
Build the flags array.


toArray()   X-Ref
Returns the internal header array in array format.

return: array  The headers in array format.

toString()   X-Ref
Returns the internal header array in string format.

return: string  The headers in string format.

addReceivedHeader()   X-Ref
Generate the 'Received' header for the Web browser->Horde hop
(attempts to conform to guidelines in RFC 2821).


addMessageIdHeader()   X-Ref
Generate the 'Message-ID' header.


addResentHeaders($from, $to)   X-Ref
Generate the 'Resent' headers (conforms to guidelines in
RFC 2822 [3.6.6]).

param: string $from  The address to use for 'Resent-From'.
param: string $to    The address to use for 'Resent-To'.

addDeliveryReceiptHeaders($to)   X-Ref
Generate delivery receipt headers.

param: string $to  The address the receipt should be mailed to.

addAgentHeader()   X-Ref
Generate the user agent description header.


getAgentHeader()   X-Ref
Returns the user agent description header.

return: string  The user agent header.

addHeader($header, $value)   X-Ref
Add a header to the header array.

param: string $header  The header name.
param: string $value   The header value.

removeHeader($header)   X-Ref
Remove a header from the header array.

param: string $header  The header name.

setValue($header, $value)   X-Ref
Set a value for a particular header ONLY if that header is set.

param: string $header  The header name.
param: string $value   The header value.
return: boolean  True if value was set, false if not.

getString($header)   X-Ref
Attempts to return the header in the correct case.

param: string $header  The header to search for.
return: string  The value for the given header.

getValue($header)   X-Ref
Attempt to return the value for a given header.
The following header fields can only have 1 entry, so if duplicate
entries exist, the first value will be used:
* To, From, Cc, Bcc, Date, Sender, Reply-to, Message-ID, In-Reply-To,
References, Subject (RFC 2822 [3.6])
* All List Headers (RFC 2369 [3])

param: string $header  The header to search for.
return: mixed  The value for the given header.

alteredHeader($header)   X-Ref
Has the header been altered from the original?

param: string $header  The header to analyze.
return: boolean  True if the header has been altered.

setValueByFunction($header, $funcs)   X-Ref
Transforms a Header value using the list of functions provided.

param: string $header  The header to alter.
param: mixed $funcs    A function, or an array of functions.

addMIMEHeaders(&$mime_part)   X-Ref
Add any MIME headers required for the MIME_Part.

param: MIME_Part &$mime_part  The MIME_Part object.

getAddressesFromObject($obs)   X-Ref
Return the list of addresses for a header object.

param: array $obs  An array of header objects (See imap_headerinfo()
return: array  An array of objects.

listHeaders()   X-Ref
Returns the list of valid mailing list headers.

return: array  The list of valid mailing list headers.

listHeadersExist()   X-Ref
Do any mailing list headers exist?

return: boolean  True if any mailing list headers exist.

setEOL($eol)   X-Ref
Sets a new string to use for EOLs.

param: string $eol  The string to use for EOLs.

getEOL()   X-Ref
Get the string to use for EOLs.

return: string  The string to use for EOLs.

getFlag($flag)   X-Ref
Returns the flag status.

param: string $flag  Is this flag set?
return: boolean  True if the flag has been set, false if not.

getFromAddress()   X-Ref
Get the primary from address (first address in the From: header).

return: string  The from address (user@host).

getOb($field, $decode = false)   X-Ref
Get a header from the header object.

param: string $field    The object field to retrieve (see
param: boolean $decode  Should the return value be MIME decoded?
return: mixed  The field requested.



Généré le : Sun Feb 25 18:01:28 2007 par Balluche grâce à PHPXref 0.7