Path

ez components / documentation / api reference / 2007.1.1 / mail


eZ Components 2007.1.1

Mail

[ Tutorial ] [ Display example ] [ Mail listing example ] [ Rfcs ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package Mail

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

__construct : ezcMailPart
in file part.php, method ezcMailPart::__construct()
    Constructs a new mail part.
__construct : ezcMailPop3TransportOptions
in file pop3_options.php, method ezcMailPop3TransportOptions::__construct()
    Constructs an object with the specified values.
__construct : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::__construct()
    Constructs a new pop3 parser set that will fetch the messages with the id's.
__construct : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::__construct()
    Creates a new POP3 transport and connects to the $server at $port.
__construct : ezcMailParserOptions
in file parser_options.php, method ezcMailParserOptions::__construct()
    Constructs an object with the specified values.
__construct : ezcMailParser
in file parser.php, method ezcMailParser::__construct()
    Constructs a new ezcMailParser.
__construct : ezcMailComposer
in file composer.php, method ezcMailComposer::__construct()
    Constructs an empty ezcMailComposer object.
__construct : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::__construct()
    Constructs a new ezcMailMultipartReport.
__construct : ezcMailNoSuchMessageException
in file no_such_message.php, method ezcMailNoSuchMessageException::__construct()
    Constructs an ezcMailNoSuchMessageException
__construct : ezcMailOffsetOutOfRangeException
in file offset_out_of_range.php, method ezcMailOffsetOutOfRangeException::__construct()
    Constructs an ezcMailOffsetOutOfRangeException
__construct : ezcMailRfc822Digest
in file rfc822_digest.php, method ezcMailRfc822Digest::__construct()
    Constructs a new ezcMailDigest with the mail $mail.
__construct : ezcMailSmtpTransportOptions
in file smtp_options.php, method ezcMailSmtpTransportOptions::__construct()
    Constructs an object with the specified values.
__construct : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::__construct()
    Constructs a new ezcMailSmtpTransport.
__construct : ezcMailVariableSet
in file var_set.php, method ezcMailVariableSet::__construct()
    Constructs a new set that contains one mail from $mail.
__construct : ezcMailVirtualFile
in file virtual_file.php, method ezcMailVirtualFile::__construct()
    Constructs a new attachment with $fileName and $contents.
__construct : ezcMailPartWalkContext
in file walk_context.php, method ezcMailPartWalkContext::__construct()
    Constructs a new ezcMailPartWalkContext object.
__construct : ezcMailTransportOptions
in file transport_options.php, method ezcMailTransportOptions::__construct()
    Constructs an object with the specified values.
__construct : ezcMailMtaTransport
in file transport_mta.php, method ezcMailMtaTransport::__construct()
    Constructs a new ezcMailMtaTransport.
__construct : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::__construct()
    Constructs a new storage set around the provided set.
__construct : ezcMailStreamFile
in file stream_file.php, method ezcMailStreamFile::__construct()
    Constructs a new attachment with $fileName and $stream.
__construct : ezcMailText
in file text.php, method ezcMailText::__construct()
    Constructs a new TextPart with the given $text, $charset and $encoding.
__construct : ezcMailTransportException
in file transport_exception.php, method ezcMailTransportException::__construct()
    Constructs an ezcMailTransportException with low level information $message.
__construct : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::__construct()
    Constructs a new ezcMailMultipartMixed
__construct : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::__construct()
    Constructs a new ezcMailMultipartRelated.
__construct : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::__construct()
    Creates a new IMAP transport and connects to the $server at $port.
__construct : ezcMailMultipartDigest
in file multipart_digest.php, method ezcMailMultipartDigest::__construct()
    Constructs a new ezcMailMultipartDigest
__construct : ezcMailInvalidLimitException
in file invalid_limit.php, method ezcMailInvalidLimitException::__construct()
    Constructs an ezcMailInvalidLimitException
__construct : ezcMailFile
in file disk_file.php, method ezcMailFile::__construct()
    Constructs a new attachment with $fileName.
__construct : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::__construct()
    Constructs a new imap parser set that will fetch the messages with the id's.
__construct : ezcMailFilePart
in file file.php, method ezcMailFilePart::__construct()
    Constructs a new attachment with $fileName.
__construct : ezcMailImapTransportOptions
in file imap_options.php, method ezcMailImapTransportOptions::__construct()
    Constructs an object with the specified values.
__construct : ezcMail
in file mail.php, method ezcMail::__construct()
    Constructs an empty ezcMail object.
__construct : ezcMailAddress
in file mail_address.php, method ezcMailAddress::__construct()
    Constructs a new ezcMailAddress with the mail address $email and the optional name $name.
__construct : ezcMailMboxTransport
in file mbox_transport.php, method ezcMailMboxTransport::__construct()
    Constructs the ezcMailMboxTransport object
__construct : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::__construct()
    Constructs a new ezcMailMultipart with the parts $parts.
__construct : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::__construct()
    Constructs a new ezcMailMultipartAlternative
__construct : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::__construct()
    Constructs a new mbox parser set.
__construct : ezcMailException
in file mail_exception.php, method ezcMailException::__construct()
    Constructs a new ezcMailException with error message $message.
__construct : ezcMailDeliveryStatus
in file delivery_status.php, method ezcMailDeliveryStatus::__construct()
    Constructs a new DeliveryStatus part.
__construct : ezcMailContentDispositionHeader
in file content_disposition_header.php, method ezcMailContentDispositionHeader::__construct()
    Constructs a new ezcMailContentDispositionHeader holding the various values of this container.
__construct : ezcMailFileSet
in file file_set.php, method ezcMailFileSet::__construct()
    Constructs a new set that servers the files specified by $files.
__destruct : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::__destruct()
    Destructs this object.
__destruct : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::__destruct()
    Destructs the IMAP transport.
__destruct : ezcMailFileSet
in file file_set.php, method ezcMailFileSet::__destruct()
    Destructs the set.
__destruct : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::__destruct()
    Destructs the POP3 transport object.
__destruct : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::__destruct()
    Destructs the set.
__set_state : ezcMailContentDispositionHeader
in file content_disposition_header.php, method ezcMailContentDispositionHeader::__set_state()
    Returns a new instance of this class with the data specified by $array.
__set_state : ezcMailAddress
in file mail_address.php, method ezcMailAddress::__set_state()
    Returns a new instance of this class with the data specified by $array.
__toString : ezcMailAddress
in file mail_address.php, method ezcMailAddress::__toString()
    Returns string representation of email address on string cast.

a

$additionalParameters : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$additionalParameters
    Any additional parameters provided in the Content-Disposition header.
$additionalParametersMetaData : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$additionalParametersMetaData
    Holds language and characterset data for the additional parameters.
addAttachment : ezcMailComposer
in file composer.php, method ezcMailComposer::addAttachment()
    Adds the file $fileName to the list of attachments.
addBcc : ezcMail
in file mail.php, method ezcMail::addBcc()
    Adds the ezcMailAddress $address to the list of 'bcc' recipients.
addCc : ezcMail
in file mail.php, method ezcMail::addCc()
    Adds the ezcMailAddress $address to the list of 'cc' recipients.
addRelatedPart : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::addRelatedPart()
    Adds $part to the list of parts and returns the Content-ID of the part.
addTo : ezcMail
in file mail.php, method ezcMail::addTo()
    Adds the ezcMailAddress $address to the list of 'to' recipients.
append : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::append()
    Appends $mail to the $mailbox mailbox.
appendExcludeHeaders : ezcMailPart
in file part.php, method ezcMailPart::appendExcludeHeaders()
    The array $headers will be excluded when the headers are generated.
appendPart : ezcMailPartWalkContext
in file walk_context.php, method ezcMailPartWalkContext::appendPart()
    Appends a part to the list of mail parts.
appendPart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::appendPart()
    Appends a part to the list of parts.
appendPart : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::appendPart()
    Appends a part to the list of parts.
appendPart : ezcMailMultipartDigest
in file multipart_digest.php, method ezcMailMultipartDigest::appendPart()
    Appends a part to the list of parts.
appendPart : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::appendPart()
    Appends a part to the list of parts.
authenticate : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::authenticate()
    Authenticates the user to the POP3 server with $user and $password.
authenticate : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::authenticate()
    Authenticates the user to the IMAP server with $user and $password.
BASE64 : ezcMail
in file mail.php, class constant ezcMail::BASE64
    Base 64 encoding.

b

build : ezcMailComposer
in file composer.php, method ezcMailComposer::build()
    Builds the complete email message in RFC822 format.

c

$charset : ezcMailAddress
in file mail_address.php, variable ezcMailAddress::$charset
    The character set used in the $name property.
$creationDate : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$creationDate
    The creation date of the file attachment.
capability : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::capability()
    Returns an array with the capabilities of the IMAP server.
clearFlag : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::clearFlag()
    Clears $flag from $messages.
cmdRcpt : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::cmdRcpt()
    Sends the 'RCTP TO' to the server with the address $email.
collectPart : ezcMail
in file mail.php, method ezcMail::collectPart()
    Saves $mail in the $context object.
composeEmailAddress : ezcMailTools
in file tools.php, method ezcMailTools::composeEmailAddress()
    Returns ezcMailAddress $item as a RFC822 compliant address string.
composeEmailAddresses : ezcMailTools
in file tools.php, method ezcMailTools::composeEmailAddresses()
    Returns the array $items consisting of ezcMailAddress objects as one RFC822 compliant address string.
convertToUTF8 : ezcMailCharsetConverter
in file charset_convert.php, method ezcMailCharsetConverter::convertToUTF8()
    Converts the $text with the charset $originalCharset to UTF-8.
convertToUTF8Iconv : ezcMailCharsetConverter
in file charset_convert.php, method ezcMailCharsetConverter::convertToUTF8Iconv()
    Converts the $text with the charset $originalCharset to UTF-8.
copyMessages : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::copyMessages()
    Copies message(s) from the selected mailbox to mailbox $destination.
countByFlag : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::countByFlag()
    Wrapper function to fetch count of messages by a certain flag.
createMailbox : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::createMailbox()
    Creates the mailbox $mailbox.
createRecipient : ezcMailDeliveryStatus
in file delivery_status.php, method ezcMailDeliveryStatus::createRecipient()
    Adds a new recipient to this delivery-status message and returns the index of the last added recipient.
composer.php
procedural page composer.php
charset_convert.php
procedural page charset_convert.php
content_disposition_header.php
procedural page content_disposition_header.php

d

$disposition : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$disposition
    The disposition type, either "inline" or "attachment".
delete : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::delete()
    Deletes the message with the message number $msgNum from the server.
delete : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::delete()
    Deletes the message with the message number $msgNum from the server.
deleteMailbox : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::deleteMailbox()
    Deletes the mailbox $mailbox.
disconnect : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::disconnect()
    Sends the QUIT command to the server and breaks the connection.
disconnect : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::disconnect()
    Disconnects the transport from the POP3 server.
disconnect : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::disconnect()
    Disconnects the transport from the IMAP server.
delivery_status_parser.php
procedural page delivery_status_parser.php
delivery_status.php
procedural page delivery_status.php
disk_file.php
procedural page disk_file.php

e

$email : ezcMailAddress
in file mail_address.php, variable ezcMailAddress::$email
    The email address of the recipient.
expunge : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::expunge()
    Sends an EXPUNGE command to the server.
ezcMail
in file mail.php, class ezcMail
    The main mail class.
ezcMailAddress
in file mail_address.php, class ezcMailAddress
    A container to store a mail address in RFC822 format.
ezcMailCharsetConverter
in file charset_convert.php, class ezcMailCharsetConverter
    Class containing common character set conversion methods.
ezcMailComposer
in file composer.php, class ezcMailComposer
    Convenience class for writing mail.
ezcMailContentDispositionHeader
in file content_disposition_header.php, class ezcMailContentDispositionHeader
    A container to store a Content-Disposition header as described in http://www.faqs.org/rfcs/rfc2183.
ezcMailDeliveryStatus
in file delivery_status.php, class ezcMailDeliveryStatus
    Mail part used for sending delivery status message.
ezcMailException
in file mail_exception.php, class ezcMailException
    ezcMailExceptions are thrown when an exceptional state occures in the Mail package.
ezcMailFile
in file disk_file.php, class ezcMailFile
    Mail part for binary data from the file system.
ezcMailFilePart
in file file.php, class ezcMailFilePart
    Mail part for all forms of binary data.
ezcMailFileSet
in file file_set.php, class ezcMailFileSet
    ezcMailFileSet is an internal class that can be used to parse mail directly from files on disk.
ezcMailImapSet
in file imap_set.php, class ezcMailImapSet
    ezcMailImapSet is an internal class that fetches a series of mail from the imap server.
ezcMailImapTransport
in file imap_transport.php, class ezcMailImapTransport
    ezcMailImapTransport implements IMAP for mail retrieval.
ezcMailImapTransportOptions
in file imap_options.php, class ezcMailImapTransportOptions
    Class containing the options for IMAP transport.
ezcMailInvalidLimitException
in file invalid_limit.php, class ezcMailInvalidLimitException
    The ezcMailInvalidLimitException is thrown when request is made to fetch messages with the offset outside of the existing message range.
ezcMailMboxSet
in file mbox_set.php, class ezcMailMboxSet
    ezcMailMboxSet is an internal class that fetches a series of mail from an mbox file.
ezcMailMboxTransport
in file mbox_transport.php, class ezcMailMboxTransport
    ezcMailMboxTransport implements mail retrieval from an mbox file.
ezcMailMtaTransport
in file transport_mta.php, class ezcMailMtaTransport
    Implementation of the mail transport interface using the system MTA.
ezcMailMultipart
in file multipart.php, class ezcMailMultipart
    Abstract base class for all multipart types.
ezcMailMultipartAlternative
in file multipart_alternative.php, class ezcMailMultipartAlternative
    ezcMailMultipartAlternative is used to bundle a group of mail parts where only one should be shown.
ezcMailMultipartDigest
in file multipart_digest.php, class ezcMailMultipartDigest
    The digest multipart type is used to bundle a list of mail objects.
ezcMailMultipartMixed
in file multipart_mixed.php, class ezcMailMultipartMixed
    The mixed multipart type is used to bundle an ordered list of mail parts.
ezcMailMultipartRelated
in file multipart_related.php, class ezcMailMultipartRelated
    ezcMailMultipartRelated is intended for mail parts consisting of several inter-related body parts.
ezcMailMultipartReport
in file multipart_report.php, class ezcMailMultipartReport
    Mail part multipart/report used primarily to send delivery status notification messages.
ezcMailNoSuchMessageException
in file no_such_message.php, class ezcMailNoSuchMessageException
    The ezcMailNoSuchMessageException is thrown when a message with an ID is requested that doesn't exist in the transport.
ezcMailOffsetOutOfRangeException
in file offset_out_of_range.php, class ezcMailOffsetOutOfRangeException
    The ezcMailOffsetOutOfRangeException is thrown when request is made to fetch messages with the offset outside of the existing message range.
ezcMailParser
in file parser.php, class ezcMailParser
    Parses a mail in RFC822 format to an ezcMail structure.
ezcMailParserOptions
in file parser_options.php, class ezcMailParserOptions
    Class containing the basic options for the mail parser.
ezcMailParserSet
in file parser_set.php, class ezcMailParserSet
    Interface common to all parser sets.
ezcMailPart
in file part.php, class ezcMailPart
    Abstract base class for all mail MIME parts.
ezcMailPartWalkContext
in file walk_context.php, class ezcMailPartWalkContext
    Use this class to create a context to be passed to the walkParts() method from ezcMail.
ezcMailPop3Set
in file pop3_set.php, class ezcMailPop3Set
    ezcMailPop3Set is an internal class that fetches a series of mail from the pop3 server.
ezcMailPop3Transport
in file pop3_transport.php, class ezcMailPop3Transport
    ezcMailPop3Transport implements POP3 for mail retrieval.
ezcMailPop3TransportOptions
in file pop3_options.php, class ezcMailPop3TransportOptions
    Class containing the options for POP3 transport.
ezcMailRfc822Digest
in file rfc822_digest.php, class ezcMailRfc822Digest
    Mail part or mail digest parts.
ezcMailSmtpTransport
in file transport_smtp.php, class ezcMailSmtpTransport
    This class implements the Simple Mail Transfer Protocol (SMTP) with authentication support.
ezcMailSmtpTransportOptions
in file smtp_options.php, class ezcMailSmtpTransportOptions
    Class containing the options for SMTP transport.
ezcMailStorageSet
in file storage_set.php, class ezcMailStorageSet
    ezcMailStorageSet is a wrapper around other mail sets and provides saving of mail sources to files.
ezcMailStreamFile
in file stream_file.php, class ezcMailStreamFile
    Mail part for data in a stream.
ezcMailText
in file text.php, class ezcMailText
    Mail part used for sending all forms of plain text.
ezcMailTools
in file tools.php, class ezcMailTools
    This class contains static convenience methods for composing addresses and ensuring correct line-breaks in the mail.
ezcMailTransport
in file transport.php, class ezcMailTransport
    Interface for classes that implement a mail transport.
ezcMailTransportException
in file transport_exception.php, class ezcMailTransportException
    Transport exceptions are thrown when either sending or receiving mail transports fail to do their job properly.
ezcMailTransportOptions
in file transport_options.php, class ezcMailTransportOptions
    Class containing the basic options for mail transports.
ezcMailVariableSet
in file var_set.php, class ezcMailVariableSet
    ezcMailVariableSet is an internal class that can be used to parse mail directly from a string variable in your script.
ezcMailVirtualFile
in file virtual_file.php, class ezcMailVirtualFile
    Mail part for binary data in memory.
ezcSignalStaticConnectionsBase
in file static_connections_base.php, class ezcSignalStaticConnectionsBase
    Interface for classes that implement a mail transport.
REPLY_ALL : ezcMailTools
in file tools.php, class constant ezcMailTools::REPLY_ALL
    Reply to all.
REPLY_SENDER : ezcMailTools
in file tools.php, class constant ezcMailTools::REPLY_SENDER
    Reply to sender.
SEVEN_BIT : ezcMail
in file mail.php, class constant ezcMail::SEVEN_BIT
    7 bit encoding.

f

$fh : ezcMailMboxTransport
in file mbox_transport.php, variable ezcMailMboxTransport::$fh
    Holds the filepointer to the mbox
$fileName : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$fileName
    The filename of the attachment.
$fileNameCharSet : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$fileNameCharSet
    The characterset of the file name.
$fileNameLanguage : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$fileNameLanguage
    The language of the filename.
fetchAll : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::fetchAll()
    Returns a parserset with all the messages on the server.
fetchAll : ezcMailMboxTransport
in file mbox_transport.php, method ezcMailMboxTransport::fetchAll()
    Returns an ezcMailMboxSet containing all the messages in the mbox.
fetchAll : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::fetchAll()
    Returns a parserset with all the messages on the server.
fetchByFlag : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::fetchByFlag()
    Fetches messages by a certain flag.
fetchByMessageNr : ezcMailMboxTransport
in file mbox_transport.php, method ezcMailMboxTransport::fetchByMessageNr()
    Returns an ezcMailMboxSet containing only the $number -th message in the mbox.
fetchByMessageNr : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::fetchByMessageNr()
    Returns an ezcMailPop3Set containing only the $number -th message in the mailbox.
fetchByMessageNr : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::fetchByMessageNr()
    Returns an ezcMailImapSet containing only the $number -th message in the mailbox.
fetchFlags : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::fetchFlags()
    Fetches IMAP flags for messages $messages.
fetchFromOffset : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::fetchFromOffset()
    Returns an ezcMailPop3Set with $count messages starting from $offset.
fetchFromOffset : ezcMailMboxTransport
in file mbox_transport.php, method ezcMailMboxTransport::fetchFromOffset()
    Returns an ezcMailMboxSet with $count messages starting from $offset.
fetchFromOffset : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::fetchFromOffset()
    Returns an ezcMailImapSet with $count messages starting from $offset.
fetchParts : ezcMail
in file mail.php, method ezcMail::fetchParts()
    Returns an array of mail parts from the current mail.
file_parser.php
procedural page file_parser.php
file.php
procedural page file.php
file_set.php
procedural page file_set.php

g

generate : ezcMailPart
in file part.php, method ezcMailPart::generate()
    Returns the complete mail part including both the header and the body as a string.
generate : ezcMailFilePart
in file file.php, method ezcMailFilePart::generate()
    Override of the generate() method from ezcMailPart. Used to set headers before generating the part.
generateBody : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::generateBody()
    Returns the generated body for all multipart types.
generateBody : ezcMailStreamFile
in file stream_file.php, method ezcMailStreamFile::generateBody()
    Returns the contents of the file with the correct encoding.
generateBody : ezcMailVirtualFile
in file virtual_file.php, method ezcMailVirtualFile::generateBody()
    Returns the contents of the file with the correct encoding.
generateBody : ezcMailDeliveryStatus
in file delivery_status.php, method ezcMailDeliveryStatus::generateBody()
    Returns the generated text body of this part as a string.
generateBody : ezcMailText
in file text.php, method ezcMailText::generateBody()
    Returns the generated text body of this part as a string.
generateBody : ezcMailPart
in file part.php, method ezcMailPart::generateBody()
    Returns the body of this part as a string.
generateBody : ezcMail
in file mail.php, method ezcMail::generateBody()
    Returns the generated body part of this mail.
generateBody : ezcMailFile
in file disk_file.php, method ezcMailFile::generateBody()
    Returns the contents of the file with the correct encoding.
generateBody : ezcMailRfc822Digest
in file rfc822_digest.php, method ezcMailRfc822Digest::generateBody()
    Returns the body part of this mail consisting of the digested mail.
generateBoundary : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::generateBoundary()
    Returns a unique boundary string.
generateContentId : ezcMailTools
in file tools.php, method ezcMailTools::generateContentId()
    Returns an unique ID to be used for Content-ID headers.
generateHeaders : ezcMailDeliveryStatus
in file delivery_status.php, method ezcMailDeliveryStatus::generateHeaders()
    Returns the headers set for this part as a RFC822 compliant string.
generateHeaders : ezcMailPart
in file part.php, method ezcMailPart::generateHeaders()
    Returns the headers set for this part as a RFC 822 string.
generateHeaders : ezcMail
in file mail.php, method ezcMail::generateHeaders()
    Returns the generated headers for the mail.
generateHeaders : ezcMailText
in file text.php, method ezcMailText::generateHeaders()
    Returns the headers set for this part as a RFC822 compliant string.
generateMessageId : ezcMailTools
in file tools.php, method ezcMailTools::generateMessageId()
    Returns an unique message ID to be used for a mail message.
getConnections : ezcSignalStaticConnectionsBase
in file static_connections_base.php, method ezcSignalStaticConnectionsBase::getConnections()
    Returns all the connections for signals $signal in signal collections with the identifier $identifier.
getHeader : ezcMailPart
in file part.php, method ezcMailPart::getHeader()
    Returns the RAW value of the header $name.
getMachinePart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::getMachinePart()
    Returns the machine part of this multipart or null if there is no such part.
getMainPart : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::getMainPart()
    Returns the main part of this multipart or null if there is no such part.
getMessageNumbers : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::getMessageNumbers()
    Returns message numbers for current set.
getMessageNumbers : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::getMessageNumbers()
    Returns message numbers for current set.
getMessageNumbers : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::getMessageNumbers()
    Returns message numbers for current set.
getNextLine : ezcMailVariableSet
in file var_set.php, method ezcMailVariableSet::getNextLine()
    Returns one line of data from the current mail in the set.
getNextLine : ezcMailFileSet
in file file_set.php, method ezcMailFileSet::getNextLine()
    Returns one line of data from the current mail in the set.
getNextLine : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::getNextLine()
    Returns one line of data from the current mail in the set.
getNextLine : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::getNextLine()
    Returns one line of data from the current mail in the set.
getNextLine : ezcMailParserSet
in file parser_set.php, method ezcMailParserSet::getNextLine()
    Returns one line of data from the current mail in the set including the ending linebreak.
getNextLine : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::getNextLine()
    Returns one line of data from the current mail in the set including the ending linebreak.
getNextLine : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::getNextLine()
    Returns one line of data from the current mail in the set.
getOriginalPart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::getOriginalPart()
    Returns the original content part of this multipart or null if there is no such part.
getParts : ezcMailPartWalkContext
in file walk_context.php, method ezcMailPartWalkContext::getParts()
    Returns the mail parts.
getParts : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::getParts()
    Returns the mail parts associated with this multipart.
getParts : ezcMailMultipartDigest
in file multipart_digest.php, method ezcMailMultipartDigest::getParts()
    Returns the mail parts associated with this multipart.
getParts : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::getParts()
    Returns the mail parts associated with this multipart.
getParts : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::getParts()
    Returns the mail parts associated with this multipart.
getReadablePart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::getReadablePart()
    Returns the readable part of this multipart or null if there is no such part.
getRelatedPartByID : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::getRelatedPartByID()
    Returns the part associated with the passed Content-ID.
getRelatedParts : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::getRelatedParts()
    Returns the mail parts associated with this multipart.
getSourceFiles : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::getSourceFiles()
    Returns an array of the filenames holding the sources of the mails in this set.
getTmpDir : ezcMailParser
in file parser.php, method ezcMailParser::getTmpDir()
    Returns the temporary directory.
guessContentType : ezcMailTools
in file tools.php, method ezcMailTools::guessContentType()
    Guesses the content and mime type by using the file extension.

h

hasData : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::hasData()
    Returns whether the set has mails
hasData : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::hasData()
    Returns whether the set has mails.
hasData : ezcMailVariableSet
in file var_set.php, method ezcMailVariableSet::hasData()
    Returns whether the variable set contains mails.
hasData : ezcMailParserSet
in file parser_set.php, method ezcMailParserSet::hasData()
    Returns true if mail data is available for parsing.
hasData : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::hasData()
    Returns whether the set contains mails.
hasData : ezcMailFileSet
in file file_set.php, method ezcMailFileSet::hasData()
    Returns whether the file set contains files
hasData : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::hasData()
    Returns whether the set has mails
headers_holder.php
procedural page headers_holder.php

i

BINARY : ezcMail
in file mail.php, class constant ezcMail::BINARY
    Binary encoding.
DISPLAY_ATTACHMENT : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::DISPLAY_ATTACHMENT
    Use DISPLAY_ATTACHMENT if you want the file to be displayed as an attachment to the recipients of the mail.
DISPLAY_INLINE : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::DISPLAY_INLINE
    Use DISPLAY_INLINE if you want the file to be displayed inline in the mail to the recipients.
EIGHT_BIT : ezcMail
in file mail.php, class constant ezcMail::EIGHT_BIT
    8 bit encoding.
isFinished : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::isFinished()
    Returns true if all the data has been fetched from this set.
isFinished : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::isFinished()
    Returns true if all the data has been fetched from this set.
isFinished : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::isFinished()
    Returns true if all the data has been fetched from this set.
invalid_limit.php
procedural page invalid_limit.php
imap_options.php
procedural page imap_options.php
imap_set.php
procedural page imap_set.php
imap_transport.php
procedural page imap_transport.php

k

keepConnection : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::keepConnection()
    Sets if the connection should be kept open after sending an email.

l

lineBreak : ezcMailTools
in file tools.php, method ezcMailTools::lineBreak()
    Returns one endLine character.
listMailboxes : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::listMailboxes()
    Lists the available mailboxes on the IMAP server.
listMessages : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::listMessages()
    Returns a list of the messages on the server and the size of the messages in bytes.
listMessages : ezcMailMboxTransport
in file mbox_transport.php, method ezcMailMboxTransport::listMessages()
    This function reads through the whole mbox and returns starting positions of the messages.
listMessages : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::listMessages()
    Returns a list of the not deleted messages in the current mailbox.
listUniqueIdentifiers : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::listUniqueIdentifiers()
    Returns the unique identifiers for messages on the POP3 server.
listUniqueIdentifiers : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::listUniqueIdentifiers()
    Returns the unique identifiers messages on the IMAP server.

m

$modificationDate : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$modificationDate
    The last modification date of the file attachment.
mail_exception.php
procedural page mail_exception.php
mail.php
procedural page mail.php
multipart_alternative_parser.php
procedural page multipart_alternative_parser.php
multipart_digest_parser.php
procedural page multipart_digest_parser.php
multipart_mixed_parser.php
procedural page multipart_mixed_parser.php
multipart_parser.php
procedural page multipart_parser.php
multipart_related_parser.php
procedural page multipart_related_parser.php
multipart_report_parser.php
procedural page multipart_report_parser.php
multipart.php
procedural page multipart.php
multipart_alternative.php
procedural page multipart_alternative.php
multipart_digest.php
procedural page multipart_digest.php
multipart_mixed.php
procedural page multipart_mixed.php
multipart_related.php
procedural page multipart_related.php
multipart_report.php
procedural page multipart_report.php
mail_address.php
procedural page mail_address.php
mbox_set.php
procedural page mbox_set.php
mbox_transport.php
procedural page mbox_transport.php
mta_transport.php
procedural page mta_transport.php
mimeDecode : ezcMailTools
in file tools.php, method ezcMailTools::mimeDecode()
    Decodes mime encoded fields and tries to recover from errors.
multipartType : ezcMailMultipartDigest
in file multipart_digest.php, method ezcMailMultipartDigest::multipartType()
    Returns "digest".
multipartType : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::multipartType()
    Returns "report".
multipartType : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::multipartType()
    Returns "mixed".
multipartType : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::multipartType()
    Returns "related".
multipartType : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::multipartType()
    Returns "alternative".
multipartType : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::multipartType()
    Returns the type of multipart.

n

$name : ezcMailAddress
in file mail_address.php, variable ezcMailAddress::$name
    The name of the recipient (optional).
no_such_message.php
procedural page no_such_message.php
nextMail : ezcMailStorageSet
in file storage_set.php, method ezcMailStorageSet::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailVariableSet
in file var_set.php, method ezcMailVariableSet::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailPop3Set
in file pop3_set.php, method ezcMailPop3Set::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailParserSet
in file parser_set.php, method ezcMailParserSet::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailImapSet
in file imap_set.php, method ezcMailImapSet::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailFileSet
in file file_set.php, method ezcMailFileSet::nextMail()
    Moves the set to the next mail and returns true upon success.
nextMail : ezcMailMboxSet
in file mbox_set.php, method ezcMailMboxSet::nextMail()
    Moves the set to the next mail and returns true upon success.
noop : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::noop()
    Sends a NOOP command to the server, use it to keep the connection alive.
noop : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::noop()
    Sends a NOOP command to the server, use it to keep the connection alive.

o

CONNECTION_PLAIN : ezcMailSmtpTransport
in file transport_smtp.php, class constant ezcMailSmtpTransport::CONNECTION_PLAIN
    Plain connection.
CONNECTION_SSL : ezcMailSmtpTransport
in file transport_smtp.php, class constant ezcMailSmtpTransport::CONNECTION_SSL
    SSL connection.
CONNECTION_SSLV2 : ezcMailSmtpTransport
in file transport_smtp.php, class constant ezcMailSmtpTransport::CONNECTION_SSLV2
    SSLv2 connection.
CONNECTION_SSLV3 : ezcMailSmtpTransport
in file transport_smtp.php, class constant ezcMailSmtpTransport::CONNECTION_SSLV3
    SSLv3 connection.
CONNECTION_TLS : ezcMailSmtpTransport
in file transport_smtp.php, class constant ezcMailSmtpTransport::CONNECTION_TLS
    TLS connection.
CONTENT_TYPE_APPLICATION : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::CONTENT_TYPE_APPLICATION
    Application content type. Use this if the file non of the other content types match.
CONTENT_TYPE_AUDIO : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::CONTENT_TYPE_AUDIO
    Audio content type. Use this if the contents of the file is an audio.
CONTENT_TYPE_IMAGE : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::CONTENT_TYPE_IMAGE
    Image content type. Use this if the contents of the file is an image.
CONTENT_TYPE_VIDEO : ezcMailFilePart
in file file.php, class constant ezcMailFilePart::CONTENT_TYPE_VIDEO
    Video content type. Use this if the contents of the file is a video.
offset_out_of_range.php
procedural page offset_out_of_range.php

p

$parts : ezcMailPartWalkContext
in file walk_context.php, variable ezcMailPartWalkContext::$parts
    An array of mail parts (retrieved recursively from a mail object).
$parts : ezcMailMultipart
in file multipart.php, variable ezcMailMultipart::$parts
    An array holding the parts of this multipart.
$properties : ezcMailFilePart
in file file.php, variable ezcMailFilePart::$properties
    Holds the properties of this class.
part.php
procedural page part.php
parser_options.php
procedural page parser_options.php
pop3_options.php
procedural page pop3_options.php
parser_set.php
procedural page parser_set.php
part_parser.php
procedural page part_parser.php
parser.php
procedural page parser.php
pop3_set.php
procedural page pop3_set.php
pop3_transport.php
procedural page pop3_transport.php
parseEmailAddress : ezcMailTools
in file tools.php, method ezcMailTools::parseEmailAddress()
    Returns an ezcMailAddress object parsed from the address string $address.
parseEmailAddresses : ezcMailTools
in file tools.php, method ezcMailTools::parseEmailAddresses()
    Returns an array of ezcMailAddress objects parsed from the address string $addresses.
parseMail : ezcMailParser
in file parser.php, method ezcMailParser::parseMail()
    Returns an array of ezcMail objects parsed from the mail set $set.

r

$readDate : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$readDate
    The last date the file attachment was read.
rfc822_digest_parser.php
procedural page rfc822_digest_parser.php
rfc822_parser.php
procedural page rfc822_parser.php
rfc822_digest.php
procedural page rfc822_digest.php
renameMailbox : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::renameMailbox()
    Renames the mailbox $mailbox to $newName.
replyToMail : ezcMailTools
in file tools.php, method ezcMailTools::replyToMail()
    Returns a new mail object that is a reply to the current object.

s

$size : ezcMailContentDispositionHeader
in file content_disposition_header.php, variable ezcMailContentDispositionHeader::$size
    The size of the content in bytes.
smtp_options.php
procedural page smtp_options.php
shutdown_handler.php
procedural page shutdown_handler.php
stream_file.php
procedural page stream_file.php
smtp_transport.php
procedural page smtp_transport.php
storage_set.php
procedural page storage_set.php
selectMailbox : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::selectMailbox()
    Selects the mailbox $mailbox.
send : ezcMailMtaTransport
in file transport_mta.php, method ezcMailMtaTransport::send()
    Sends the mail $mail using the PHP mail method.
send : ezcMailTransport
in file transport.php, method ezcMailTransport::send()
    Sends the contents of $mail.
send : ezcMailSmtpTransport
in file transport_smtp.php, method ezcMailSmtpTransport::send()
    Sends the ezcMail $mail using the SMTP protocol.
setConvertMethod : ezcMailCharsetConverter
in file charset_convert.php, method ezcMailCharsetConverter::setConvertMethod()
    Sets the callback function used for character set conversion to UTF-8.
setFlag : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::setFlag()
    Sets $flag on $messages.
setHeader : ezcMailPart
in file part.php, method ezcMailPart::setHeader()
    Sets the header $name to the value $value.
setHeaders : ezcMailPart
in file part.php, method ezcMailPart::setHeaders()
    Adds the headers $headers.
setLineBreak : ezcMailTools
in file tools.php, method ezcMailTools::setLineBreak()
    Sets the endLine $character(s) to use when generating mail.
setMachinePart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::setMachinePart()
    Sets the machine $part of this report multipart.
setMainPart : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::setMainPart()
    Sets the main part $part of this alternative multipart.
setOriginalPart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::setOriginalPart()
    Sets the original content $part of this report multipart.
setReadablePart : ezcMailMultipartReport
in file multipart_report.php, method ezcMailMultipartReport::setReadablePart()
    Sets the readable $part of this report multipart.
setTmpDir : ezcMailParser
in file parser.php, method ezcMailParser::setTmpDir()
    Sets the temporary directory.
static_connections_base.php
procedural page static_connections_base.php
sortFromOffset : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::sortFromOffset()
    Fetches $count messages from $offset sorted by $sortCriteria.
sortMessages : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::sortMessages()
    Fetches messages $messages sorted by $sortCriteria.
status : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::status()
    Returns information about messages in the selected mailbox.
status : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::status()
    Returns the number of messages on the server and the combined size of the messages through the input variables $numMessages and $sizeMessages.

t

transport_exception.php
procedural page transport_exception.php
transport.php
procedural page transport.php
transport_options.php
procedural page transport_options.php
text_parser.php
procedural page text_parser.php
text.php
procedural page text.php
tools.php
procedural page tools.php
transport_mta.php
procedural page transport_mta.php
transport_smtp.php
procedural page transport_smtp.php
top : ezcMailPop3Transport
in file pop3_transport.php, method ezcMailPop3Transport::top()
    Returns the headers and the $numLines first lines of the body of the mail with the message number $msgNum.
top : ezcMailImapTransport
in file imap_transport.php, method ezcMailImapTransport::top()
    Returns the headers and the first characters from message $msgNum, without setting the \Seen flag.

u

AUTH_APOP : ezcMailPop3Transport
in file pop3_transport.php, class constant ezcMailPop3Transport::AUTH_APOP
    APOP authorization.
AUTH_PLAIN_TEXT : ezcMailPop3Transport
in file pop3_transport.php, class constant ezcMailPop3Transport::AUTH_PLAIN_TEXT
    Plain text authorization.
QUOTED_PRINTABLE : ezcMail
in file mail.php, class constant ezcMail::QUOTED_PRINTABLE
    Quoted printable encoding.
url_exception.php
procedural page url_exception.php
url_invalid_parameter_exception.php
procedural page url_invalid_parameter_exception.php
url_not_registered_exception.php
procedural page url_not_registered_exception.php
url_no_configuration_exception.php
procedural page url_no_configuration_exception.php

v

virtual_file.php
procedural page virtual_file.php
var_set.php
procedural page var_set.php

w

walk_context.php
procedural page walk_context.php
walkParts : ezcMail
in file mail.php, method ezcMail::walkParts()
    Walks recursively through the mail parts in the specified mail object.
Last updated: Wed, 28 Nov 2007