[ class tree: ] [ index: ] [ all elements ]

Index of all elements

[ a ] [ b ] [ c ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ _ ]

a

addAlternativePart
in file mime.php, method Mail_mime::addAlternativePart()
    Adds a multipart/alternative part to a mimePart object (or creates one), and returns it during the build process.
addAttachment
in file mime.php, method Mail_mime::addAttachment()
    Adds a file to the list of attachments.
addAttachmentPart
in file mime.php, method Mail_mime::addAttachmentPart()
    Adds an attachment subpart to a mimePart object and returns it during the build process.
addBcc
in file mime.php, method Mail_mime::addBcc()
    Add an email to the Bcc (blank carbon copy) header (multiple calls to this method are allowed)
addCc
in file mime.php, method Mail_mime::addCc()
    Add an email to the Cc (carbon copy) header (multiple calls to this method are allowed)
addHTMLImage
in file mime.php, method Mail_mime::addHTMLImage()
    Adds an image to the list of embedded images.
addHtmlImagePart
in file mime.php, method Mail_mime::addHtmlImagePart()
    Adds an html image subpart to a mimePart object and returns it during the build process.
addHtmlPart
in file mime.php, method Mail_mime::addHtmlPart()
    Adds a html subpart to the mimePart object and returns it during the build process.
addMixedPart
in file mime.php, method Mail_mime::addMixedPart()
    Creates a new mimePart object, using multipart/mixed as the initial content-type and returns it during the build process.
addRelatedPart
in file mime.php, method Mail_mime::addRelatedPart()
    Adds a multipart/related part to a mimePart object (or creates one), and returns it during the build process.
addSubpart
in file mimePart.php, method Mail_mimePart::addSubpart()
    Adds a subpart to current mime part and returns a reference to it
addTextPart
in file mime.php, method Mail_mime::addTextPart()
    Adds a text subpart to the mimePart object and returns it during the build process.
addTo
in file mime.php, method Mail_mime::addTo()
    Add an email to the To header (multiple calls to this method are allowed)
top

b

$body
in file mimePart.php, variable Mail_mimePart::$body
    The body of this part (not encoded)
$body_file
in file mimePart.php, variable Mail_mimePart::$body_file
    The location of file with body of this part (not encoded)
$build_params
in file mime.php, variable Mail_mime::$build_params
    Build parameters
basename
in file mime.php, method Mail_mime::basename()
    Get file's basename (locale independent)
buildHeaderParam
in file mimePart.php, method Mail_mimePart::buildHeaderParam()
    Encodes the parameter of a header.
buildRFC2047Param
in file mimePart.php, method Mail_mimePart::buildRFC2047Param()
    Encodes header parameter as per RFC2047 if needed
top

c

checkParams
in file mime.php, method Mail_mime::checkParams()
    Validate and set build parameters
contentHeaders
in file mime.php, method Mail_mime::contentHeaders()
    Get Content-Type and Content-Transfer-Encoding headers of the message
top

e

$encoded
in file mimePart.php, variable Mail_mimePart::$encoded
    The output of this part after being built
$encoding
in file mimePart.php, variable Mail_mimePart::$encoding
    The encoding type of this part
$eol
in file mimePart.php, variable Mail_mimePart::$eol
    The end-of-line sequence
encode
in file mimePart.php, method Mail_mimePart::encode()
    Encodes and returns the email. Also stores it in the encoded member variable
encodeHeader
in file mime.php, method Mail_mime::encodeHeader()
    Encodes a header as per RFC2047
encodeHeader
in file mimePart.php, method Mail_mimePart::encodeHeader()
    Encodes a header as per RFC2047
encodeHeaders
in file mime.php, method Mail_mime::encodeHeaders()
    Encodes headers as per RFC2047
encodeHeaderValue
in file mimePart.php, method Mail_mimePart::encodeHeaderValue()
    Encodes a header value as per RFC2047
encodeMB
in file mimePart.php, method Mail_mimePart::encodeMB()
    Encodes the given string using base64 or quoted-printable.
encodePartToFile
in file mimePart.php, method Mail_mimePart::encodePartToFile()
    Encodes given email part into file
encodeQP
in file mimePart.php, method Mail_mimePart::encodeQP()
    Encodes the given string using quoted-printable
encodeRecipients
in file mime.php, method Mail_mime::encodeRecipients()
    Since the PHP send function requires you to specify recipients (To: header) separately from the other headers, the To: header is not properly encoded.
encodeReplaceCallback
in file mimePart.php, method Mail_mimePart::encodeReplaceCallback()
    Callback function to replace extended characters (\x80-xFF) with their ASCII values (RFC2231)
encodeToFile
in file mimePart.php, method Mail_mimePart::encodeToFile()
    Encodes and saves the email into file or stream.
explodeQuotedString
in file mimePart.php, method Mail_mimePart::explodeQuotedString()
    Explode quoted string
top

f

file2str
in file mime.php, method Mail_mime::file2str()
    Get the contents of the given file name as string
top

g

get
in file mime.php, method Mail_mime::get()
    Builds the multipart message from the list ($this->parts) and returns the mime content.
getEncodedData
in file mimePart.php, method Mail_mimePart::getEncodedData()
    Returns encoded data based upon encoding passed to it
getEncodedDataFromFile
in file mimePart.php, method Mail_mimePart::getEncodedDataFromFile()
    Returns encoded data based upon encoding passed to it
getHTMLBody
in file mime.php, method Mail_mime::getHTMLBody()
    Get message HTML body
getMessage
in file mime.php, method Mail_mime::getMessage()
    Returns the complete e-mail, ready to send using an alternative
getMessageBody
in file mime.php, method Mail_mime::getMessageBody()
    Returns the complete e-mail body, ready to send using an alternative mail delivery method.
getParam
in file mime.php, method Mail_mime::getParam()
    Get build parameter value
getTXTBody
in file mime.php, method Mail_mime::getTXTBody()
    Get message text body
top

h

$headers
in file mimePart.php, variable Mail_mimePart::$headers
    Headers for this part
$headers
in file mime.php, variable Mail_mime::$headers
    Headers for the mail
$htmlbody
in file mime.php, variable Mail_mime::$htmlbody
    Contains the html part of the email
$html_images
in file mime.php, variable Mail_mime::$html_images
    list of the attached images
headers
in file mime.php, method Mail_mime::headers()
    Returns an array with the headers needed to prepend to the email (MIME-Version and Content-Type). Format of argument is: $array['header-name'] = 'header-value';
top

i

isError
in file mime.php, method Mail_mime::isError()
    PEAR::isError implementation
isMultipart
in file mime.php, method Mail_mime::isMultipart()
    Checks if the current message has many parts
top

m

Mail_mime
in file mime.php, class Mail_mime
    The Mail_Mime class provides an OO interface to create MIME enabled email messages. This way you can create emails that contain plain-text bodies, HTML bodies, attachments, inline images and specific headers.
mime.php
procedural page mime.php
mimePart.php
procedural page mimePart.php
Mail_mimePart
in file mimePart.php, class Mail_mimePart
    The Mail_mimePart class is used to create MIME E-mail messages
top

p

$parts
in file mime.php, variable Mail_mime::$parts
    list of the attachements
phail.php
procedural page phail.php
top

q

qpReplaceCallback
in file mimePart.php, method Mail_mimePart::qpReplaceCallback()
    Callback function to replace extended characters (\x80-xFF) with their ASCII values (RFC2047: quoted-printable)
quotedPrintableEncode
in file mimePart.php, method Mail_mimePart::quotedPrintableEncode()
    Encodes data to quoted-printable standard.
top

r

raiseError
in file mimePart.php, method Mail_mimePart::raiseError()
    PEAR::raiseError implementation
raiseError
in file mime.php, method Mail_mime::raiseError()
    PEAR::raiseError implementation
top

s

$subparts
in file mimePart.php, variable Mail_mimePart::$subparts
    An array of subparts
saveMessage
in file mime.php, method Mail_mime::saveMessage()
    Writes (appends) the complete e-mail into file.
saveMessageBody
in file mime.php, method Mail_mime::saveMessageBody()
    Writes (appends) the complete e-mail body into file or stream.
setContentType
in file mime.php, method Mail_mime::setContentType()
    Sets message Content-Type header.
setFrom
in file mime.php, method Mail_mime::setFrom()
    Set an email to the From (the sender) header
setHTMLBody
in file mime.php, method Mail_mime::setHTMLBody()
    Adds a html part to the mail.
setParam
in file mime.php, method Mail_mime::setParam()
    Set build parameter value
setSubject
in file mime.php, method Mail_mime::setSubject()
    Sets the Subject header
setTXTBody
in file mime.php, method Mail_mime::setTXTBody()
    Accessor function to set the body text. Body text is used if it's not an html mail being sent or else is used to fill the text/plain part that emails clients who don't support html should show.
top

t

$txtbody
in file mime.php, variable Mail_mime::$txtbody
    Contains the plain text part of the email
txtHeaders
in file mime.php, method Mail_mime::txtHeaders()
    Get the text version of the headers (usefull if you want to use the PHP mail() function)
top

u

usage
in file phail.php, function usage()
top

_

__construct
in file mimePart.php, method Mail_mimePart::__construct()
    Constructor.
__construct
in file mime.php, method Mail_mime::__construct()
    Constructor function
top

Documentation generated on Sun, 05 Jul 2015 12:30:03 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.