void AddAddress(
string
$address, [string
$name = '']
)
|
|
Adds a "To" address.
Parameters:
|
string |
$address: |
|
|
string |
$name: |
|
API Tags:
bool AddAttachment(
string
$path, [string
$name = ''], [string
$encoding = 'base64'], [string
$type = 'application/octet-stream']
)
|
|
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found or accessed.
Parameters:
|
string |
$path: |
Path to the attachment. |
|
string |
$name: |
Overrides the attachment name. |
|
string |
$encoding: |
File encoding (see $Encoding). |
|
string |
$type: |
File extension (MIME) type. |
API Tags:
void AddBCC(
string
$address, [string
$name = '']
)
|
|
Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Parameters:
|
string |
$address: |
|
|
string |
$name: |
|
API Tags:
void AddCC(
string
$address, [string
$name = '']
)
|
|
Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Parameters:
|
string |
$address: |
|
|
string |
$name: |
|
API Tags:
void AddCustomHeader(
$custom_header
)
|
|
Adds a custom header.
Parameters:
API Tags:
bool AddEmbeddedImage(
string
$path, string
$cid, [string
$name = ''], [string
$encoding = 'base64'], [string
$type = 'application/octet-stream']
)
|
|
Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif".
Parameters:
|
string |
$path: |
Path to the attachment. |
|
string |
$cid: |
Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form. |
|
string |
$name: |
Overrides the attachment name. |
|
string |
$encoding: |
File encoding (see $Encoding). |
|
string |
$type: |
File extension (MIME) type. |
API Tags:
string AddrAppend(
$type,
$addr
)
|
|
Creates recipient headers.
Parameters:
API Tags:
void AddReplyTo(
string
$address, [string
$name = '']
)
|
|
Adds a "Reply-to" address.
Parameters:
|
string |
$address: |
|
|
string |
$name: |
|
API Tags:
string AddrFormat(
$addr
)
|
|
Formats an address correctly.
Parameters:
API Tags:
void AddStringAttachment(
string
$string, string
$filename, [string
$encoding = 'base64'], [string
$type = 'application/octet-stream']
)
|
|
Adds a string or binary attachment (non-filesystem) to the list.
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
Parameters:
|
string |
$string: |
String attachment data. |
|
string |
$filename: |
Name of the attachment. |
|
string |
$encoding: |
File encoding (see $Encoding). |
|
string |
$type: |
File extension (MIME) type. |
API Tags:
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
API Tags:
string Base64EncodeWrapMB(
string
$str
)
|
|
Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
Parameters:
|
string |
$str: |
multi-byte text to wrap encode |
API Tags:
Clears all recipients assigned in the TO array. Returns void.
API Tags:
void ClearAllRecipients(
)
|
|
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
API Tags:
Clears all previously set filesystem, string, and binary attachments. Returns void.
API Tags:
Clears all recipients assigned in the BCC array. Returns void.
API Tags:
Clears all recipients assigned in the CC array. Returns void.
API Tags:
void ClearCustomHeaders(
)
|
|
Clears all custom headers. Returns void.
API Tags:
Clears all recipients assigned in the ReplyTo array. Returns void.
API Tags:
Assembles the message body. Returns an empty string on failure.
API Tags:
Assembles message header.
API Tags:
string EncodeFile(
$path, [
$encoding = 'base64']
)
|
|
Encodes attachment in requested format. Returns an empty string on failure.
Parameters:
API Tags:
string EncodeHeader(
$str, [
$position = 'text']
)
|
|
Encode a header string to best of Q, B, quoted or none.
Parameters:
API Tags:
string EncodeQ(
$str, [
$position = 'text']
)
|
|
Encode string to q encoding.
Parameters:
API Tags:
string EncodeQP(
[
$input = ''], [integer
$line_max = 76], [
$space_conv = false], string
$string
)
|
|
Encode string to quoted-printable.
Parameters:
|
string |
$string: |
the text to encode |
|
integer |
$line_max: |
Number of chars allowed on a line before wrapping |
|
|
$input: |
|
|
|
$space_conv: |
|
API Tags:
string EncodeString(
$str, [
$encoding = 'base64']
)
|
|
Encodes string to requested format. Returns an empty string on failure.
Parameters:
API Tags:
void EndBoundary(
$boundary
)
|
|
Returns the end of a message boundary.
Parameters:
API Tags:
void GetBoundary(
$boundary,
$charSet,
$contentType,
$encoding
)
|
|
Returns the start of a message boundary.
Parameters:
|
|
$boundary: |
|
|
|
$charSet: |
|
|
|
$contentType: |
|
|
|
$encoding: |
|
API Tags:
void getFile(
string
$filename
)
|
|
Read a file from a supplied filename and return it.
Parameters:
|
string |
$filename: |
Parameter File Name |
API Tags:
Returns the message MIME.
API Tags:
bool HasMultiBytes(
string
$str
)
|
|
Checks if a string contains multibyte characters.
Parameters:
|
string |
$str: |
multi-byte text to wrap encode |
API Tags:
void HeaderLine(
$name,
$value
)
|
|
Parameters:
API Tags:
bool InlineImageExists(
)
|
|
Returns true if an inline attachment is present.
API Tags:
Returns true if an error occurred.
API Tags:
void IsHTML(
bool
$bool
)
|
|
Sets message type to HTML.
Parameters:
API Tags:
Sets Mailer to send message using PHP mail() function.
API Tags:
Sets Mailer to send message using the qmail MTA.
API Tags:
Sets Mailer to send message using the $Sendmail program.
API Tags:
Sets Mailer to send message using SMTP.
API Tags:
bool MailSend(
$header,
$body
)
|
|
Sends mail using the PHP mail() function.
Parameters:
API Tags:
$message MsgHTML(
$message, [
$basedir = '']
)
|
|
Evaluates the message and returns modifications for inline images and backgrounds
Parameters:
API Tags:
string SecureHeader(
string
$str
)
|
|
Strips newlines to prevent header injection.
Parameters:
API Tags:
Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.
API Tags:
bool SendmailSend(
$header,
$body
)
|
|
Sends mail using the $Sendmail program.
Parameters:
API Tags:
void set(
string
$name, [mixed
$value = '']
)
|
|
Set (or reset) Class Objects (variables)
Usage Example: $page->set('X-Priority', '3');
Parameters:
|
string |
$name: |
Parameter Name |
|
mixed |
$value: |
Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset |
API Tags:
bool SetLanguage(
[string
$lang_type = 'en'], [string
$lang_path = 'language/']
)
|
|
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
Parameters:
|
string |
$lang_type: |
Type of language (e.g. Portuguese: "br") |
|
string |
$lang_path: |
Path to the language file directory |
API Tags:
Sets the message type.
API Tags:
Set the body wrapping.
API Tags:
void Sign(
$cert_filename, string
$key_filename, string
$key_pass
)
|
|
Set the private key file and password to sign the message.
Parameters:
|
string |
$key_filename: |
Parameter File Name |
|
string |
$key_pass: |
Password for private key |
|
|
$cert_filename: |
|
API Tags:
Closes the active SMTP session if one exists.
API Tags:
Initiates a connection to an SMTP server. Returns false if the operation failed.
API Tags:
bool SmtpSend(
$header,
$body
)
|
|
Sends mail via SMTP using PhpSMTP (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Parameters:
API Tags:
string TextLine(
$value
)
|
|
Returns a formatted mail line.
Parameters:
API Tags:
int UTF8CharBoundary(
string
$encodedText, int
$maxLength
)
|
|
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
Parameters:
|
string |
$encodedText: |
utf-8 QP text |
|
int |
$maxLength: |
find last character boundary prior to this length |
API Tags:
string WrapText(
$message,
$length, [
$qp_mode = false]
)
|
|
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Original written by philippe.
Parameters:
|
|
$message: |
|
|
|
$length: |
|
|
|
$qp_mode: |
|
API Tags:
mime _mime_types(
[
$ext = '']
)
|
|
Gets the mime type of the embedded or inline image
Parameters:
API Tags:
| Return: | type of ext |
| Access: | public |