Mail_Mime |
![]() |
[ class tree: Mail_Mime ] [ index: Mail_Mime ] [ all elements ] |
![]() |
Packages: Mail_Mime Classes: Files: |
[ Top ] $calbody =[line 104] Contains the text/calendar part of the email
[ Top ] $headers = array()[line 125] Headers for the mail
[ Top ] $htmlbody =[line 97] Contains the html part of the email
[ Top ] $html_images = array()[line 111] List of the attached images
[ Top ] $parts = array()[line 118] List of the attachements
[ Top ] $txtbody =[line 90] Contains the plain text part of the email
[ Top ] Method Detail__construct (Constructor) [line 173]
Constructor function
Parameters:
[ Top ]
addAlternativePart [line 582]
Adds a multipart/alternative part to a mimePart object (or creates one), and returns it during the build process.
Parameters:
[ Top ]
addAttachment [line 400]
Adds a file to the list of attachments.
Parameters:
[ Top ]
addAttachmentPart [line 658]
Adds an attachment subpart to a mimePart object and returns it during the build process.
Parameters:
[ Top ]
addBcc [line 1245]
Add an email to the Bcc (blank carbon copy) header (multiple calls to this method are allowed)
Parameters:
[ Top ]
addBodyPart [line 1542]
Adds a subpart to the mimePart object and returns it during the build process.
Parameters:
[ Top ]
addCalendarPart [line 547]
Adds a calendar subpart to the mimePart object and returns it during the build process.
Parameters:
[ Top ]
addCc [line 1228]
Add an email to the Cc (carbon copy) header (multiple calls to this method are allowed)
Parameters:
[ Top ]
addHTMLImage [line 329]
Adds an image to the list of embedded images. Images added this way will be added as related parts of the HTML message. To correctly match the HTML image with the related attachment HTML should refer to it by a filename (specified in $file or $name arguments) or by cid:<content-id> (specified in $content_id arg).
Parameters:
[ Top ]
addHtmlImagePart [line 629]
Adds an html image subpart to a mimePart object and returns it during the build process.
Parameters:
[ Top ]
addHtmlPart [line 533]
Adds a html subpart to the mimePart object and returns it during the build process.
Parameters:
[ Top ]
addMixedPart [line 563]
Creates a new mimePart object, using multipart/mixed as the initial content-type and returns it during the build process.
Parameters:
[ Top ]
addRelatedPart [line 606]
Adds a multipart/related part to a mimePart object (or creates one), and returns it during the build process.
Parameters:
[ Top ]
addTextPart [line 519]
Adds a text subpart to the mimePart object and returns it during the build process.
Parameters:
[ Top ]
addTo [line 1211]
Add an email to the To header (multiple calls to this method are allowed)
Parameters:
[ Top ]
basename [line 1335]
Get file's basename (locale independent)
Parameters:
[ Top ]
buildAlternativeParts [line 982]
Builds a single text, html, or calendar part only if one of them is found. If two or more parts are found, then an alternative part containing them is built.
Parameters:
[ Top ]
buildBodyPart [line 949]
Builds the main body MIME part for the email body. It will add a mixed part if attachments are found. If no attachments are found it will return an alternative part if several body texts are found (text, html, calendar), or a single part if only one body text is found.
[ Top ]
buildHtmlParts [line 1023]
Builds html part as a single part or inside a related part with the html images thar were found.
Parameters:
[ Top ]
checkParams [line 1455]contentHeaders [line 1350]
Get Content-Type and Content-Transfer-Encoding headers of the message
[ Top ]
encodeHeader [line 1321]
Encodes a header as per RFC2047
Parameters:
[ Top ]
encodeHeaders [line 1281]
Encodes headers as per RFC2047
Parameters:
[ Top ]
encodeRecipients [line 1265]
Since the PHP send function requires you to specify recipients (To: header) separately from the other headers, the To: header is not properly encoded. To fix this, you can use this public method to encode your recipients before sending to the send function.
Parameters:
[ Top ]
file2str [line 483]
Get the contents of the given file name as string
Parameters:
[ Top ]
get [line 856]
Builds the multipart message from the list ($this->parts) and returns the mime content.
Parameters:
[ Top ]
getCalendarBody [line 305]
Get body of calendar part
[ Top ]
getHTMLBody [line 266]getMessage [line 719]
Returns the complete e-mail, ready to send using an alternative mail delivery method. Note that only the mailpart that is made with Mail_Mime is created. This means that, YOU WILL HAVE NO TO: HEADERS UNLESS YOU SET IT YOURSELF using the $headers parameter!
Parameters:
[ Top ]
getMessageBody [line 745]
Returns the complete e-mail body, ready to send using an alternative mail delivery method.
Parameters:
[ Top ]
getParam [line 210]
Get build parameter value
Parameters:
[ Top ]
getTXTBody [line 241]headers [line 1058]
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';
Parameters:
[ Top ]
isError [line 1565]
PEAR::isError implementation
Parameters:
[ Top ]
isMultipart [line 470]
Checks if the current message has many parts
[ Top ]
raiseError [line 1582]
PEAR::raiseError implementation
Parameters:
[ Top ]
saveMessage [line 764]
Writes (appends) the complete e-mail into file.
Parameters:
[ Top ]
saveMessageBody [line 809]
Writes (appends) the complete e-mail body into file or stream.
Parameters:
[ Top ]
setBody [line 1512]
Set body of specified message part
Parameters:
[ Top ]
setCalendarBody [line 287]
Function to set a body of text/calendar part (not attachment)
Parameters:
[ Top ]
setContentType [line 1145]
Sets message Content-Type header. Use it to build messages with various content-types e.g. miltipart/raport not supported by contentHeaders() function.
Parameters:
[ Top ]
setFrom [line 1198]
Set an email to the From (the sender) header
Parameters:
[ Top ]
setHTMLBody [line 255]
Adds a html part to the mail.
Parameters:
[ Top ]
setParam [line 197]
Set build parameter value
Parameters:
[ Top ]
setSubject [line 1186]
Sets the Subject header
Parameters:
[ Top ]
setTXTBody [line 230]
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.
Parameters:
[ Top ]
txtHeaders [line 1106]
Get the text version of the headers (usefull if you want to use the PHP mail() function)
Parameters:
[ Top ]
Documentation generated on Sun, 01 Mar 2020 02:56:06 -0500 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004. |