[Horde_MIME] element index

Package indexes

All elements
a b c d e f g h i l m o p q r s t u v w _
_
top
Variable $_agent
MIME_Headers::$_agent in Headers.php
The User-Agent string to use.
Variable $_allHeaders
Cached output of the MIME_Structure::parseMIMEHeaders() command.
Variable $_atc
MIME_Contents::$_atc in Contents.php
The attachments list.
Variable $_attach822
The number of message/rfc822 levels labeled as 'attachments' of the current part.
Variable $_base
MIME_Contents::$_base in Contents.php
The base MIME_Contents object.
Variable $_body
MIME_Mail::$_body in Mail.php
The main body part.
Variable $_body_id
MIME_Contents::$_body_id in Contents.php
The MIME part id of the message body.
Variable $_boundary
Unique MIME_Part boundary string.
Variable $_build
MIME_Message::$_build in Message.php
Has the message been parsed via buildMessage()?
Variable $_bytes
MIME_Part::$_bytes in Part.php
Default value for this Part's size.
Variable $_cachemessage
The MIME_Message object we use when caching.
Variable $_cids
MIME_Part::$_cids in Part.php
The list of CIDs for this part.
Variable $_contentid
The content-ID for this part.
Variable $_contents
The body of the part.
Variable $_contentTypeParameters
The content type parameters of this part.
Variable $_currentEncoding
The current transfer encoding of the contents of this part.
Variable $_defaultServer
The server to default unqualified addresses to.
Variable $_description
The description of this part.
Variable $_displayType
The attachment display type to use.
Variable $_disposition
The disposition of this part (inline or attachment).
Variable $_dispositionParameters
The disposition parameters of this part.
Variable $_downloads
List of all downloadable parts.
Variable $_encode7bit
Should the message be encoded via 7-bit?
Variable $_eol
MIME_Headers::$_eol in Headers.php
The sequence to use as EOL for the headers.
Variable $_eol
MIME_Part::$_eol in Part.php
The sequence to use as EOL for this part.
Variable $_flags
MIME_Part::$_flags in Part.php
Internal class flags.
Variable $_flags
MIME_Headers::$_flags in Headers.php
The internal flags array.
Variable $_headerObject
The header object returned from imap_headerinfo().
Variable $_headers
The MIME_Headers object.
Variable $_headers
The message headers.
Variable $_headers
The internal headers array.
Variable $_headerText
Cached output of the imap_fetchheader() command.
Variable $_htmlBody
The main HTML body part.
Variable $_idmap
MIME_Part::$_idmap in Part.php
Part -> ID mapping cache.
Variable $_index
MIME_Headers::$_index in Headers.php
The index of the message.
Variable $_information
Information/Statistics on the subpart.
Variable $_links
MIME_Contents::$_links in Contents.php
Show the links in the summaries?
Variable $_mailer_driver
The Mail driver name.
Variable $_mailer_params
The Mail driver parameters.
Variable $_message
MIME_Contents::$_message in Contents.php
The MIME_Message object for the message.
Variable $_mimeid
The MIME ID of this part.
Variable $_mimekey
MIME_Contents::$_mimekey in Contents.php
The MIME index key to use.
Variable $_msgtext
The text of the original message.
Variable $_parts
MIME_Part::$_parts in Part.php
The subparts of this part.
Variable $_parts
MIME_Mail::$_parts in Mail.php
All MIME parts except the main body part.
Variable $_parts
MIME_Contents::$_parts in Contents.php
The message parts list.
Variable $_recipients
The message recipients.
Variable $_sessionCacheID
The Cache_session identifier.
Variable $_subtype
The subtype (ex.: plain) of this part.
Variable $_summary
MIME_Contents::$_summary in Contents.php
The summary parts list.
Variable $_summaryType
The summary type.
Variable $_transferEncoding
The desired transfer encoding of this part.
Variable $_type
MIME_Part::$_type in Part.php
The type (ex.: text) of this part.
Variable $_viewerCache
The MIME_Viewer object cache.
Variable $_viewID
MIME_Contents::$_viewID in Contents.php
The actionID value for various actions.
Method _buildRecipients
Builds a recipients list.
Method _getStream
Returns a reference to a currently open IMAP stream.
a
top
Method addAgentHeader
Generate the user agent description header.
Method addAttachment
Adds an attachment.
Method addCID
Add to the list of CIDs for this part.
Method addDeliveryReceiptHeaders
Generate delivery receipt headers.
Method addHeader
Adds a message header.
Method addHeader
Add a header to the header array.
Method addHeaders
Adds several message headers at once.
Method addMDNRequestHeaders
Add a MDN (read receipt) request headers to the MIME_Headers object.
Method addMessageIdHeader
Generate the 'Message-ID' header.
Method addMIMEHeaders
Add any MIME headers required for the MIME_Part.
Method addMIMEPart
Adds a MIME message part.
Method addMultipartInfo
Set the special information for certain MIME types.
Method addPart
Add a MIME subpart.
Method addPart
Adds a message part.
Method addrArray2String
Takes an array of address objects, as returned by imap_headerinfo(), for example, and passes each of them through MIME::addrObject2String().
Method addReceivedHeader
Generate the 'Received' header for the Web browser->Horde hop (attempts to conform to guidelines in RFC 2821).
Method addRecipients
Adds message recipients.
Method addResentHeaders
Generate the 'Resent' headers (conforms to guidelines in RFC 2822 [3.6.6]).
Method addrObject2String
Takes an address object, as returned by imap_header() for example, and formats it as a string.
Method alteredHeader
Has the header been altered from the original?
Method alterPart
Alter a current MIME subpart.
Method analyzeData
Uses variants of the UNIX "file" command to attempt to determine the MIME type of an unknown byte stream.
Method analyzeFile
Uses variants of the UNIX "file" command to attempt to determine the MIME type of an unknown file.
Method appendContents
Add to the body contents of this part.
b
top
Method bareAddress
Returns the bare address.
Method buildFlags
Build the flags array.
Method buildHeaders
Build the header array.
Method buildMessage
Build the message deciding what MIME Parts to show.
Method buildMessage
Build message from current contents.
Method buildMessagePart
Processes a MIME_Part and stores the display information in the internal class variables.
c
top
Method cacheIDURLParam
Add the current object to the cache, and return the cache identifier to be used in URLs.
Method canDisplayInline
Determine if we can (and know how to) inline a MIME Part.
Method clearContents
Clears the body contents of this part.
Method clearContentTypeParameter
Clears a content type parameter from this part.
Method clearRecipients
Removes all message recipients.
Method contentTypeMap
Returns a mapping of all MIME IDs to their content-types.
Method convertMIMEPart
Create a MIME_Message object from a MIME_Part object.
Page Contents.php
Contents.php in Contents.php
d
top
Method decode
MIME::decode() in MIME.php
Decodes an RFC 2047-encoded string.
Method decodeAddrString
Decodes an RFC 2047-encoded address string.
Method decodeRFC2231
Decodes an RFC 2231-encoded string.
e
top
Constant ENC7BIT
ENC7BIT in MIME.php
Constant ENC8BIT
ENC8BIT in MIME.php
Constant ENCBASE64
ENCBASE64 in MIME.php
Constant ENCBINARY
ENCBINARY in MIME.php
Method encode
MIME_Message::encode() in Message.php
Take a set of headers and make sure they are encoded properly.
Method encode
MIME::encode() in MIME.php
Encodes a string containing non-ASCII characters according to RFC 2047.
Method encodeAddress
Encodes a string containing email addresses according to RFC 2047.
Method encodeRFC2231
Encodes a string pursuant to RFC 2231.
Method encoding
MIME::encoding() in MIME.php
Returns the MIME encoding for the given input.
Constant ENCOTHER
ENCOTHER in MIME.php
Constant ENCQUOTEDPRINTABLE
ENCQUOTEDPRINTABLE in MIME.php
Method extToMIME
Attempt to convert a file extension to a MIME type, based on the global Horde and application specific config files.
f
top
Method filenameToMIME
Attempt to convert a filename to a MIME type, based on the global Horde and application specific config files.
Method findBody
Finds the main "body" text part (if any) in a message.
Method formatStatusMsg
Prints out the status message for a given MIME Part.
g
top
Method generate
Generate the MDN according to the specifications listed in RFC 3798 [3].
Method generateMessageID
Generates a Message-ID string conforming to RFC 2822 [3.6.4] and the standards outlined in 'draft-ietf-usefor-message-id-01.txt'.
Method getAddressesFromObject
Return the list of addresses for a header object.
Method getAgentHeader
Returns the user agent description header.
Method getAllContentTypeParameters
Get all parameters from the Content-Type header.
Method getAllDispositionParameters
Get all parameters from the Content-Disposition header.
Method getAllHeaders
Return the full list of headers.
Method getAttachmentContents
Returns a list of attachments and their contents.
Method getAttachments
Return the attachment list (HTML table format).
Method getBaseObjectPtr
Return a pointer to the base object.
Method getBasePart
Return the base part of the message. This function does NOT return a reference to make sure that the whole MIME_Message object isn't accidentally modified.
Method getBody
MIME_Contents::getBody() in Contents.php
Returns the entire body of the message.
Method getBodyPart
Returns the raw text for one section of the message.
Method getBytes
Determine the size of a MIME_Part and its child members.
Method getCache
Returns the cached MIME_Contents:: object.
Method getCanonicalContents
Returns the contents in strict RFC 822 & 2045 output - namely, all newlines end with the canonical <CR><LF> sequence.
Method getCharset
Get the character set to use for of this part. Returns a charset for all types (not just 'text/*') since we use this charset to determine how to encode text in MIME headers.
Method getCIDList
Returns the list of CIDs for this part.
Method getContentID
Returns the Content-ID for this part.
Method getContents
Return the body of the part.
Method getContentTypeParameter
Get a content type parameter from this part.
Method getCurrentEncoding
Retrieves the current encoding of the contents in the object.
Method getDecodedMIMEPart
Fetch part of a MIME message and decode it, if it is base_64 or qprint encoded.
Method getDefaultType
If the subtype of a MIME part is unrecognized by an application, the default type should be used instead (See RFC 2046). This method returns the default subtype for a particular primary MIME Type.
Method getDescription
Get the description of this part.
Method getDisposition
Get the content-disposition of this part.
Method getDispositionParameter
Get a disposition parameter from this part.
Method getDownloadAllList
Generate the list of MIME IDs to use for download all.
Method getEOL
MIME_Headers::getEOL() in Headers.php
Get the string to use for EOLs.
Method getEOL
Get the string to use for EOLs.
Method getFlag
Returns the flag status.
Method getFromAddress
Get the primary from address (first address in the From: header).
Method getHeaderObject
Return the header object from imap_headerinfo().
Method getHeaderText
Return the full list of headers from the imap_fetchheader() function.
Method getIndex
Returns the data for a specific MIME index.
Method getInformation
Retrieve information about the MIME_Part.
Method getMDNReturnAddr
Returns the address to return the MDN to.
Method getMessage
Return the message list (HTML table format).
Method getMIMEId
Returns the MIME ID of this part.
Method getMIMEKeyOverride
Gets the MIME key override.
Method getMIMEMessage
Returns the MIME_Message object for the mail message.
Method getMIMEPart
Fetch a part of a MIME message.
Method getMIMEViewer
Get MIME_Viewer object.
Method getMIMEViewerType
Get the MIME Content-Type output by a MIME_Viewer for a particular MIME_Part.
Method getName
Get the name of this part.
Method getOb
MIME_Headers::getOb() in Headers.php
Get a header from the header object.
Method getPart
Retrieve a specific MIME part.
Method getPart
Retrieve a specific MIME part.
Method getParts
Get a list of all MIME subparts.
Method getParts
Get a list of all MIME subparts.
Method getPrimaryType
Get the primary type of this part.
Method getRawMIMEPart
Fetch part of a MIME message.
Method getRelativeMIMEId
Returns the relative MIME ID of this part.
Method getSize
Output the size of this MIME_Part in KB.
Method getString
Attempts to return the header in the correct case.
Method getSubType
Get the subtype of this part.
Method getTransferEncoding
Get the transfer encoding for the part based on the user requested transfer encoding and the current contents of the part.
Method getType
Get the full MIME Content-Type of this part.
Method getUniqueID
Return the unique MIME_Part boundary string generated for this object.
Method getValue
Attempt to return the value for a given header.
h
top
Method header
Add the appropriate MIME headers for this part to an existing array.
Method header
MIME_Message::header() in Message.php
Add the proper set of MIME headers for this message to an array.
Constant HORDE_AGENT_HEADER
HORDE_AGENT_HEADER in Headers.php
The description of Horde to use in the 'User-Agent:' header.
Page Headers.php
Headers.php in Headers.php
i
top
Method is8bit
MIME::is8bit() in MIME.php
Determines if a string contains 8-bit (non US-ASCII) characters.
l
top
Method linkView
Generate a link to the view.php page.
Method linkViewJS
Generate a javascript link to the view.php page.
Method listHeaders
Returns the list of valid mailing list headers.
Method listHeadersExist
Do any mailing list headers exist?
m
top
Variable $mime_encodings
A listing of the allowed MIME encodings.
Variable $mime_types
MIME::$mime_types in MIME.php
A listing of the allowed MIME types.
Class MIME
MIME in MIME.php
The MIME:: class provides methods for dealing with MIME standards.
Page Magic.php
Magic.php in Magic.php
Page Mail.php
Mail.php in Mail.php
Page MDN.php
MDN.php in MDN.php
Page Message.php
Message.php in Message.php
Page mime.magic.php
mime.magic.php in mime.magic.php
Page mime.mapping.php
mime.mapping.php in mime.mapping.php
Page MIME.php
MIME.php in MIME.php
Method MIMEToExt
Attempt to convert a MIME type to a file extension, based on the global Horde and application specific config files.
Constant MIME_CODE
MIME_CODE in MIME.php
Return a code for type()/encoding().
Class MIME_Contents
MIME_Contents in Contents.php
The MIME_Contents:: class contains functions related to handling the output of MIME content.
Method MIME_Contents
Constructor.
Constant MIME_CONTENTS_CACHE
MIME_CONTENTS_CACHE in Contents.php
The name of the URL parameter that holds the MIME_Contents cache identifier.
Constant MIME_CONTENTS_DISPLAY_TYPE_BOTH
Display attachment information both in list format and inline with attachment.
Constant MIME_CONTENTS_DISPLAY_TYPE_INLINE
Display attachment information inline with attachment.
Constant MIME_CONTENTS_DISPLAY_TYPE_LIST
Display attachment information in list format.
Constant MIME_DEFAULT_CHARSET
The default MIME character set.
Constant MIME_DEFAULT_DESCRIPTION
The default MIME description.
Constant MIME_DEFAULT_DISPOSITION
The default MIME disposition.
Constant MIME_DEFAULT_ENCODING
The default MIME encoding.
Class MIME_Headers
MIME_Headers in Headers.php
The MIME_Headers:: class contains generic functions related to handling the headers of mail messages.
Method MIME_Headers
Constructor.
Class MIME_Magic
MIME_Magic in Magic.php
The MIME_Magic:: class provides an interface to determine a MIME type for various content, if it provided with different levels of information.
Method MIME_Mail
Constructor.
Class MIME_Mail
MIME_Mail in Mail.php
The MIME_Mail:: class wraps around the various MIME library classes to provide a simple interface for creating and sending MIME messages.
Class MIME_MDN
MIME_MDN in MDN.php
The MIME_MDN:: class implements Message Disposition Notifications as described by RFC 3798.
Method MIME_MDN
Constructor.
Class MIME_Message
MIME_Message in Message.php
The MIME_Message:: class provides methods for creating and manipulating MIME email messages.
Method MIME_Message
Constructor - creates a new MIME email message.
Class MIME_Part
MIME_Part in Part.php
The MIME_Part:: class provides a wrapper around MIME parts and methods for dealing with them.
Method MIME_Part
MIME_Part constructor.
Constant MIME_PART_EOL
MIME_PART_EOL in Part.php
The character(s) used internally for EOLs.
Constant MIME_PART_RFC_EOL
MIME_PART_RFC_EOL in Part.php
The character string designated by RFCs 822/2045 to designate EOLs in MIME messages.
Constant MIME_STRING
MIME_STRING in MIME.php
Return a string for type()/encoding().
Class MIME_Structure
MIME_Structure in Structure.php
$Horde: framework/MIME/MIME/Structure.php,v 1.87.10.32 2010-09-09 22:47:56 jan Exp $
o
top
Method originalMessageText
When generating the MDN, should we return the enitre text of the original message? The default is no - we only return the headers of the original message. If the text is passed in via this method, we will return the entire message.
p
top
Page Part.php
Part.php in Part.php
Method parse
MIME_Structure::parse() in Structure.php
Given the results of imap_fetchstructure(), parse the structure of the message, figuring out correct bodypart numbers, etc.
Method parseAddressList
Parses a list of email addresses into its parts.
Method parseMIMEHeaders
Builds an array consisting of MIME header/value pairs.
Method parseTextMIMEMessage
Attempts to build a MIME_Message object from a text message.
Method partSummary
Returns an array summarizing a part of a MIME message.
q
top
Method quotedPrintableEncode
Encodes a line via quoted-printable encoding.
r
top
Variable $rfc822_filter
Filter for RFC822.
Method rebuildMessage
Rebuild the MIME_Part structure of a message.
Method removeHeader
Remove a header from the header array.
Method removeHeader
Removes a message header.
Method removeIndex
Removes the message text and summary for a specific MIME index.
Method removePart
Remove a MIME_Part subpart.
Method removePart
Removes a message part.
Method removeRecipients
Removes message recipients.
Method renderMIMEAttachmentInfo
Render MIME Part attachment info.
Method renderMIMEPart
Render a MIME Part.
Method replaceEOL
Replace newlines in this part's contents with those specified by either the given newline sequence or the part's current EOL setting.
Method rfc822Explode
Explodes an RFC 2822 string, ignoring a delimiter if preceded by a "\" character, or if the delimiter is inside single or double quotes.
Method rfc822WriteAddress
Builds an RFC 822 compliant email address.
s
top
Page Structure.php
Structure.php in Structure.php
Method send
MIME_Message::send() in Message.php
Sends this message.
Method send
MIME_Mail::send() in Mail.php
Sends this message.
Method setBody
Sets the message body text.
Method setBytes
Explicitly set the size (in bytes) of this part. This value will only be returned (via getBytes()) if there are no contents currently set.
Method setCharset
Set the character set of this part.
Method setContentID
Sets the Content-ID header for this part.
Method setContents
Set the body contents of this part.
Method setContentTypeParameter
Add a content type parameter to this part.
Method setDescription
Set the description of this part.
Method setDisposition
Set the content-disposition of this part.
Method setDispositionParameter
Add a disposition parameter to this part.
Method setEOL
MIME_Headers::setEOL() in Headers.php
Sets a new string to use for EOLs.
Method setEOL
Sets a new string to use for EOLs.
Method setHTMLBody
Sets the HTML message body text.
Method setInformation
Add information about the MIME_Part.
Method setMIMEId
Alter the MIME ID of this part.
Method setMIMEKeyOverride
Sets an override for the MIME key.
Method setName
Set the name of this part.
Method setSummary
Sets a summary entry.
Method setTransferEncoding
Set the transfer encoding to use for this part.
Method setType
Set the mimetype of this part.
Method setValue
Set a value for a particular header ONLY if that header is set.
Method setValueByFunction
Transforms a Header value using the list of functions provided.
Method showSummaryLinks
Should we display links for the summaries?
Method splitContents
Split the contents of the current Part into its respective subparts, if it is multipart MIME encoding. Unlike the imap_*() functions, this will preserve all MIME header information.
Method strict7bit
Should we make sure the message is encoded via 7-bit (e.g. to adhere to mail delivery standards such as RFC 2821)?
t
top
Method toArray
Returns the internal header array in array format.
Method toCanonicalString
Returns the encoded part in strict RFC 822 & 2045 output - namely, all newlines end with the canonical <CR><LF> sequence.
Method toString
Return the entire message contents, including headers, as a string.
Method toString
Returns the internal header array in string format.
Method toString
Return the entire part in MIME format. Includes headers on request.
Method transferDecode
Decodes the contents of the part to either a 7bit or 8bit encoding.
Method transferDecodeContents
Transfer decode the contents and set them as the new contents.
Method transferEncode
Encodes the contents with the part's transfer encoding.
Method transferEncodeContents
Transfer encode the contents (to the transfer encoding identified via getTransferEncoding()) and set as the part's new contents.
Method trimEmailAddress
If an email address has no personal information, get rid of any angle brackets (<>) around it.
Method type
MIME::type() in MIME.php
Returns the MIME type for the given input.
Constant TYPEAPPLICATION
TYPEAPPLICATION in MIME.php
Constant TYPEAUDIO
TYPEAUDIO in MIME.php
Constant TYPEIMAGE
TYPEIMAGE in MIME.php
Constant TYPEMESSAGE
TYPEMESSAGE in MIME.php
Constant TYPEMODEL
TYPEMODEL in MIME.php
Older versions of PHP's imap extension don't define TYPEMODEL.
Constant TYPEMULTIPART
TYPEMULTIPART in MIME.php
Constant TYPEOTHER
TYPEOTHER in MIME.php
Constant TYPETEXT
TYPETEXT in MIME.php
Constant TYPEVIDEO
TYPEVIDEO in MIME.php
u
top
Method urlView
MIME_Contents::urlView() in Contents.php
Return the URL to the view.php page.
Method userConfirmationNeeded
Is user input required to send the MDN? Explicit confirmation is needed in some cases to prevent mail loops and the use of MDNs for mail bombing.
v
top
Method viewAsAttachment
Are we viewing this page as an attachment through view.php? This method can also be called via MIME_Contents::viewAsAttachment().
w
top
Method wrapHeaders
Adds proper linebreaks to a header string.
a b c d e f g h i l m o p q r s t u v w _