Path

ez components / documentation / api reference / 1.0 / mail


eZ Components 1.0

Mail

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package Mail

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

_

__construct : ezcMailException
in file mail_exception.php, method ezcMailException::__construct()
    Constructs a new ezcMailException with error message $message and error code $code.
__construct : ezcMailText
in file text.php, method ezcMailText::__construct()
    Constructs a new TextPart with the given $text, $charset and $encoding.
__construct : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::__construct()
    Constructs a new ezcMailMultipart with the parts $parts.
__construct : ezcMailComposer
in file composer.php, method ezcMailComposer::__construct()
    Constructs an empty ezcMailComposer object.
__construct : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::__construct()
    Constructs a new ezcMailMultipartAlternative
__construct : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::__construct()
    Constructs a new ezcMailMultipartRelated.
__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 : ezcMailTransportException
in file transport_exception.php, method ezcMailTransportException::__construct()
    Constructs an ezcMailTransportException with low level information $driverInfo.
__construct : ezcMailFile
in file file.php, method ezcMailFile::__construct()
    Constructs a new attachment with $fileName.
__construct : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::__construct()
    Constructs a new ezcMailTransportSmtp.
__construct : ezcMailTransportMta
in file transport_mta.php, method ezcMailTransportMta::__construct()
    Constructs a new ezcMailTransportMta.
__construct : ezcMail
in file mail.php, method ezcMail::__construct()
    Constructs an empty ezcMail object.
__construct : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::__construct()
    Constructs a new ezcMailMultipartMixed
__destruct : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::__destruct()
    Destructs this object.
__get : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::__get()
    Returns the property $name.
__get : ezcMailText
in file text.php, method ezcMailText::__get()
    Sets the property $name to $value.
__get : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::__get()
    Returns the property $name.
__get : ezcMailComposer
in file composer.php, method ezcMailComposer::__get()
    Returns the property $name.
__get : ezcMailFile
in file file.php, method ezcMailFile::__get()
    Sets the property $name to $value.
__get : ezcMail
in file mail.php, method ezcMail::__get()
    Returns the property $name.
__set : ezcMailComposer
in file composer.php, method ezcMailComposer::__set()
    Sets the property $name to $value.
__set : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::__set()
    Sets the property $name to $value.
__set : ezcMailText
in file text.php, method ezcMailText::__set()
    Sets the property $name to $value.
__set : ezcMail
in file mail.php, method ezcMail::__set()
    Sets the property $name to $value.
__set : ezcMailFile
in file file.php, method ezcMailFile::__set()
    Sets the property $name to $value.
__set : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::__set()
    Sets the property $name to $value.
__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.

a

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.
appendExcludeHeaders : ezcMailPart
in file part.php, method ezcMailPart::appendExcludeHeaders()
    The array $headers will be excluded when the headers are generated.
appendPart : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::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.
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.
cmdRcpt : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::cmdRcpt()
    Sends the 'RCTP TO' to the server with the address $email.
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.
composer.php
procedural page composer.php

d

disconnect : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::disconnect()
    Sends the QUIT command to the server and breaks the connection.

e

$email : ezcMailAddress
in file mail_address.php, variable ezcMailAddress::$email
    The email address of the recipient.
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.
ezcMailComposer
in file composer.php, class ezcMailComposer
    Convenience class for writing mail.
ezcMailException
in file mail_exception.php, class ezcMailException
    ezcMailExceptions are thrown when an exceptional state occures in the Mail package.
ezcMailFile
in file file.php, class ezcMailFile
    Mail part for all forms of binary data.
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.
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.
ezcMailPart
in file part.php, class ezcMailPart
    Abstract base class for all mail MIME parts.
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 linebreaks 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 by implementors of the ezcMailTransport interface when mail sending fails.
ezcMailTransportMta
in file transport_mta.php, class ezcMailTransportMta
    Implementation of the mail transport interface using the system MTA.
ezcMailTransportSmtp
in file transport_smtp.php, class ezcMailTransportSmtp
    This class implements the Simple Mail Transfer Protocol (SMTP) with authentication support.
SEVEN_BIT : ezcMail
in file mail.php, class constant ezcMail::SEVEN_BIT
    7 bit encoding.

f

file.php
procedural page file.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.
generateBody : ezcMailFile
in file file.php, method ezcMailFile::generateBody()
    Returns the contents of the file with the correct encoding.
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 : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::generateBody()
    Returns the generated body for all multipart types.
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 : ezcMailText
in file text.php, method ezcMailText::generateHeaders()
    Returns the headers set for this part as a RFC822 complient 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.
generateMessageId : ezcMailTools
in file tools.php, method ezcMailTools::generateMessageId()
    Returns an unique message ID to be used for a mail message.
getHeader : ezcMailPart
in file part.php, method ezcMailPart::getHeader()
    Returns the value of the header $name.

i

BINARY : ezcMail
in file mail.php, class constant ezcMail::BINARY
    Binary encoding.
DISPLAY_ATTACHMENT : ezcMailFile
in file file.php, class constant ezcMailFile::DISPLAY_ATTACHMENT
    Use DISPLAY_ATTACHMENT if you want the file to be displayed as an attachemnt to the repipients of the mail.
DISPLAY_INLINE : ezcMailFile
in file file.php, class constant ezcMailFile::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.

l

lineBreak : ezcMailTools
in file tools.php, method ezcMailTools::lineBreak()
    Returns one endLine character.

m

mail_exception.php
procedural page mail_exception.php
mail.php
procedural page mail.php
multipart.php
procedural page multipart.php
multipart_alternative.php
procedural page multipart_alternative.php
multipart_mixed.php
procedural page multipart_mixed.php
multipart_related.php
procedural page multipart_related.php
mail_address.php
procedural page mail_address.php
multipartType : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::multipartType()
    Returns "related".
multipartType : ezcMailMultipart
in file multipart.php, method ezcMailMultipart::multipartType()
    Returns the type of multipart.
multipartType : ezcMailMultipartAlternative
in file multipart_alternative.php, method ezcMailMultipartAlternative::multipartType()
    Returns "alternative".
multipartType : ezcMailMultipartMixed
in file multipart_mixed.php, method ezcMailMultipartMixed::multipartType()
    Returns "mixed".

n

$name : ezcMailAddress
in file mail_address.php, variable ezcMailAddress::$name
    The name of the recipient (optional).

o

CONTENT_TYPE_APPLICATION : ezcMailFile
in file file.php, class constant ezcMailFile::CONTENT_TYPE_APPLICATION
    Application content type. Use this if the file non of the other content types match.
CONTENT_TYPE_AUDIO : ezcMailFile
in file file.php, class constant ezcMailFile::CONTENT_TYPE_AUDIO
    Audio content type. Use this if the contents of the file is an audio.
CONTENT_TYPE_IMAGE : ezcMailFile
in file file.php, class constant ezcMailFile::CONTENT_TYPE_IMAGE
    Image content type. Use this if the contents of the file is an image.
CONTENT_TYPE_VIDEO : ezcMailFile
in file file.php, class constant ezcMailFile::CONTENT_TYPE_VIDEO
    Video content type. Use this if the contents of the file is a video.

p

$parts : ezcMailMultipart
in file multipart.php, variable ezcMailMultipart::$parts
    An array holding the parts of this multipart.
part.php
procedural page part.php

r

CRLF : ezcMailTransportSmtp
in file transport_smtp.php, class constant ezcMailTransportSmtp::CRLF
    The linebreak characters to use.

s

send : ezcMailTransportSmtp
in file transport_smtp.php, method ezcMailTransportSmtp::send()
    Sends the ezcMail $mail using the SMTP protocol.
send : ezcMailTransportMta
in file transport_mta.php, method ezcMailTransportMta::send()
    Sends the mail $mail using the PHP mail method.
send : ezcMailTransport
in file transport.php, method ezcMailTransport::send()
    Sends the contents of $mail.
setHeader : ezcMailPart
in file part.php, method ezcMailPart::setHeader()
    Sets the header $name to the value $value.
setLineBreak : ezcMailTools
in file tools.php, method ezcMailTools::setLineBreak()
    Sets the endLine $character(s) to use when generating mail.
setMainPart : ezcMailMultipartRelated
in file multipart_related.php, method ezcMailMultipartRelated::setMainPart()
    Sets the main part $part of this alternative multipart.

t

transport_exception.php
procedural page transport_exception.php
transport.php
procedural page transport.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

u

QUOTED_PRINTABLE : ezcMail
in file mail.php, class constant ezcMail::QUOTED_PRINTABLE
    Quoted printable encoding.
Last updated: Thu, 31 Jan 2008