com.tecnick.tcexam

# Class: PHPMailer Source Location: /shared/phpmailer/class.phpmailer.php
### Class Overview
| ### Variables $AltBody $attachment $bcc $Body $boundary $cc $CharSet $ConfirmReadingTo $ContentType $CustomHeader $Encoding $ErrorInfo $error_count $From $FromName $Helo $Host $Hostname $language $LE $Mailer $MessageID $message_type $Password $PluginDir $Port $Priority $ReplyTo $Sender $Sendmail $sign_cert_file $sign_key_file $sign_key_pass $SingleTo $smtp $SMTPAuth $SMTPDebug $SMTPKeepAlive $SMTPSecure $Subject $Timeout $to $Username $Version $WordWrap | ### Methods AddAddress AddAttachment AddBCC AddCC AddCustomHeader AddEmbeddedImage AddrAppend AddReplyTo AddrFormat AddStringAttachment AttachAll Base64EncodeWrapMB ClearAddresses ClearAllRecipients ClearAttachments ClearBCCs ClearCCs ClearCustomHeaders ClearReplyTos CreateBody CreateHeader EncodeFile EncodeHeader EncodeQ EncodeQP EncodeString EndBoundary FixEOL GetBoundary getFile GetMailMIME HasMultiBytes HeaderLine InlineImageExists IsError IsHTML IsMail IsQmail IsSendmail IsSMTP Lang MailSend MsgHTML RFCDate SecureHeader Send SendmailSend ServerHostname set SetError SetLanguage SetMessageType SetWordWrap Sign SmtpClose SmtpConnect SmtpSend TextLine UTF8CharBoundary WrapText _mime_types
### Child classes: C_mailer C_mailer - PHPMailer class extension
### Class Details [line 35] [ Top ] ### Class Variables #### $AltBody = '' [line 111] Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body. #### Tags:
access: | public
Type: | string
[ Top ] #### $attachment = array() [line 260] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $bcc = array() [line 258] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $Body = '' [line 102] Sets the Body of the message. This can be either an HTML or text body. If HTML then run IsHTML(true). #### Tags:
access: | public
Type: | string
[ Top ] #### $boundary = array() [line 263] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $cc = array() [line 257] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $CharSet = 'iso-8859-1' [line 51] Sets the CharSet of the message. #### Tags:
access: | public
Type: | string
[ Top ] #### $ConfirmReadingTo = '' [line 149] Sets the email address that a reading confirmation will be sent. #### Tags:
access: | public
Type: | string
[ Top ] #### $ContentType = 'text/plain' [line 57] Sets the Content-type of the message. #### Tags:
access: | public
Type: | string
[ Top ] #### $CustomHeader = array() [line 261] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $Encoding = '8bit' [line 64] Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable". #### Tags:
access: | public
Type: | string
[ Top ] #### $ErrorInfo = '' [line 70] Holds the most recent mailer error message. #### Tags:
access: | public
Type: | string
[ Top ] #### $error_count = 0 [line 265] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $From = 'root@localhost' [line 76] Sets the From email address for the message. #### Tags:
access: | public
Type: | string
[ Top ] #### $FromName = 'Root User' [line 82] Sets the From name of the message. #### Tags:
access: | public
Type: | string
[ Top ] #### $Helo = '' [line 190] Sets the SMTP HELO of the message (Default is $Hostname). #### Tags:
access: | public
Type: | string
[ Top ] #### $Host = 'localhost' [line 178] Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). Hosts will be tried in order. #### Tags:
access: | public
Type: | string
[ Top ] #### $Hostname = '' [line 157] Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'. #### Tags:
access: | public
Type: | string
[ Top ] #### $language = array() [line 264] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $LE = "\r\n" [line 249] Provides the ability to change the line ending #### Tags:
access: | public
Type: | string
[ Top ] #### $Mailer = 'mail' [line 124] Method to send mail: ("mail", "sendmail", or "smtp"). #### Tags:
access: | public
Type: | string
[ Top ] #### $MessageID = '' [line 164] Sets the message ID to be used in the Message-Id header. If empty, a unique id will be generated. #### Tags:
access: | public
Type: | string
[ Top ] #### $message_type = '' [line 262] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $Password = '' [line 215] Sets SMTP password. #### Tags:
access: | public
Type: | string
[ Top ] #### $PluginDir = '' [line 137] Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path. #### Tags:
access: | public
Type: | string
[ Top ] #### $Port = 25 [line 184] Sets the default SMTP server port. #### Tags:
access: | public
Type: | int
[ Top ] #### $Priority = 3 [line 45] Email priority (1 = High, 3 = Normal, 5 = low). #### Tags:
access: | public
Type: | int
[ Top ] #### $ReplyTo = array() [line 259] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $Sender = '' [line 89] Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode. #### Tags:
access: | public
Type: | string
[ Top ] #### $Sendmail = '/usr/sbin/sendmail' [line 130] Sets the path of the sendmail program. #### Tags:
access: | public
Type: | string
[ Top ] #### $sign_cert_file = "" [line 266] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $sign_key_file = "" [line 267] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $sign_key_pass = "" [line 268] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $SingleTo = false [line 243] Provides the ability to have the TO field process individual emails, instead of sending to entire TO addresses #### Tags:
access: | public
Type: | bool
[ Top ] #### $smtp = NULL [line 255] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $SMTPAuth = false [line 203] Sets SMTP authentication. Utilizes the Username and Password variables. #### Tags:
access: | public
Type: | bool
[ Top ] #### $SMTPDebug = false [line 228] Sets SMTP class debugging on or off. #### Tags:
access: | public
Type: | bool
[ Top ] #### $SMTPKeepAlive = false [line 236] Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose(). #### Tags:
access: | public
Type: | bool
[ Top ] #### $SMTPSecure = "" [line 197] Sets connection prefix. Options are "", "ssl" or "tls" #### Tags:
access: | public
Type: | string
[ Top ] #### $Subject = '' [line 95] Sets the Subject of the message. #### Tags:
access: | public
Type: | string
[ Top ] #### $Timeout = 10 [line 222] Sets the SMTP server timeout in seconds. This function will not work with the win32 version. #### Tags:
access: | public
Type: | int
[ Top ] #### $to = array() [line 256] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $Username = '' [line 209] Sets SMTP username. #### Tags:
access: | public
Type: | string
[ Top ] #### $Version = "2.3" [line 143] Holds PHPMailer version. #### Tags:
access: | public
Type: | string
[ Top ] #### $WordWrap = 0 [line 118] Sets word wrapping on the body of the message to a given number of characters. #### Tags:
access: | public
Type: | int
[ Top ] ### Class Methods ### static method RFCDate [line 1635]
`static string RFCDate( )`
Returns the proper RFC 822 formatted date. #### Tags:
access: | private
[ Top ] ### method AddAddress [line 330]
`void AddAddress( string $address, [string $name = ''])`
Adds a "To" address. #### Tags:
access: | public
#### Parameters:
string | $address |
string | $name |
[ Top ] ### method AddAttachment [line 1139]
`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. #### Tags:
access: | public
#### 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.
[ Top ] ### method AddBCC [line 358]
`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. #### Tags:
access: | public
#### Parameters:
string | $address |
string | $name |
[ Top ] ### method AddCC [line 344]
`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. #### Tags:
access: | public
#### Parameters:
string | $address |
string | $name |
[ Top ] ### method AddCustomHeader [line 1705]
`void AddCustomHeader( $custom_header)`
Adds a custom header. #### Tags:
access: | public
#### Parameters:
| $custom_header |
[ Top ] ### method AddEmbeddedImage [line 1508]
`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". #### Tags:
access: | public
#### 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.
[ Top ] ### method AddrAppend [line 696]
`string AddrAppend( $type, $addr)`
Creates recipient headers. #### Tags:
access: | public
#### Parameters:
| $type |
| $addr |
[ Top ] ### method AddReplyTo [line 370]
`void AddReplyTo( string $address, [string $name = ''])`
Adds a "Reply-to" address. #### Tags:
access: | public
#### Parameters:
string | $address |
string | $name |
[ Top ] ### method AddrFormat [line 714]
`string AddrFormat( $addr)`
Formats an address correctly. #### Tags:
access: | public
#### Parameters:
| $addr |
[ Top ] ### method AddStringAttachment [line 1482]
`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. #### Tags:
access: | public
#### Parameters:
string | $string | String attachment data.
string | $filename | Name of the attachment.
string | $encoding | File encoding (see $Encoding).
string | $type | File extension (MIME) type.
[ Top ] ### method AttachAll [line 1169]
`string AttachAll( )`
Attaches all fs, string, and binary attachments to the message. Returns an empty string on failure. #### Tags:
access: | public
[ Top ] ### method Base64EncodeWrapMB [line 1363]
`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 #### Tags:
access: | public
#### Parameters:
string | $str | multi-byte text to wrap encode
[ Top ] ### method ClearAddresses [line 1559]
`void ClearAddresses( )`
Clears all recipients assigned in the TO array. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearAllRecipients [line 1592]
`void ClearAllRecipients( )`
Clears all recipients assigned in the TO, CC and BCC array. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearAttachments [line 1603]
`void ClearAttachments( )`
Clears all previously set filesystem, string, and binary attachments. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearBCCs [line 1575]
`void ClearBCCs( )`
Clears all recipients assigned in the BCC array. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearCCs [line 1567]
`void ClearCCs( )`
Clears all recipients assigned in the CC array. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearCustomHeaders [line 1611]
`void ClearCustomHeaders( )`
Clears all custom headers. Returns void. #### Tags:
access: | public
[ Top ] ### method ClearReplyTos [line 1583]
`void ClearReplyTos( )`
Clears all recipients assigned in the ReplyTo array. Returns void. #### Tags:
access: | public
[ Top ] ### method CreateBody [line 985]
`string CreateBody( )`
Assembles the message body. Returns an empty string on failure. #### Tags:
access: | public
[ Top ] ### method CreateHeader [line 873]
`string CreateHeader( )`
Assembles message header. #### Tags:
access: | public
[ Top ] ### method EncodeFile [line 1229]
`string EncodeFile( $path, [ $encoding = 'base64'])`
Encodes attachment in requested format. Returns an empty string on failure. #### Tags:
access: | public
#### Parameters:
| $path |
| $encoding |
[ Top ] ### method EncodeHeader [line 1286]
`string EncodeHeader( $str, [ $position = 'text'])`
Encode a header string to best of Q, B, quoted or none. #### Tags:
access: | public
#### Parameters:
| $str |
| $position |
[ Top ] ### method EncodeQ [line 1448]
`string EncodeQ( $str, [ $position = 'text'])`
Encode string to q encoding. #### Tags:
access: | public
#### Parameters:
| $str |
| $position |
[ Top ] ### method EncodeQP [line 1402]
`string EncodeQP( [ $input = ''], [integer $line_max = 76], [ $space_conv = false], string $string)`
Encode string to quoted-printable. #### Tags:
access: | public
#### Parameters:
string | $string | the text to encode
integer | $line_max | Number of chars allowed on a line before wrapping
| $input |
| $space_conv |
[ Top ] ### method EncodeString [line 1256]
`string EncodeString( $str, [ $encoding = 'base64'])`
Encodes string to requested format. Returns an empty string on failure. #### Tags:
access: | public
#### Parameters:
| $str |
| $encoding |
[ Top ] ### method EndBoundary [line 1083]
`void EndBoundary( $boundary)`
Returns the end of a message boundary. #### Tags:
access: | public
#### Parameters:
| $boundary |
[ Top ] ### method FixEOL [line 1693]
`string FixEOL( $str)`
Changes every end of line from CR or LF to CRLF. #### Tags:
access: | private
#### Parameters:
| $str |
[ Top ] ### method GetBoundary [line 1059]
`void GetBoundary( $boundary, $charSet, $contentType, $encoding)`
Returns the start of a message boundary. #### Tags:
access: | public
#### Parameters:
| $boundary |
| $charSet |
| $contentType |
| $encoding |
[ Top ] ### method getFile [line 1870]
`void getFile( string $filename)`
Read a file from a supplied filename and return it. #### Tags:
access: | public
#### Parameters:
string | $filename | Parameter File Name
[ Top ] ### method GetMailMIME [line 950]
`string GetMailMIME( )`
Returns the message MIME. #### Tags:
access: | public
[ Top ] ### method HasMultiBytes [line 1347]
`bool HasMultiBytes( string $str)`
Checks if a string contains multibyte characters. #### Tags:
access: | public
#### Parameters:
string | $str | multi-byte text to wrap encode
[ Top ] ### method HeaderLine [line 1112]
`void HeaderLine( $name, $value)`
#### Tags:
access: | public
#### Parameters:
| $name |
| $value |
[ Top ] ### method InlineImageExists [line 1539]
`bool InlineImageExists( )`
Returns true if an inline attachment is present. #### Tags:
access: | public
[ Top ] ### method IsError [line 1684]
`bool IsError( )`
Returns true if an error occurred. #### Tags:
access: | public
[ Top ] ### method IsHTML [line 279]
`void IsHTML( bool $bool)`
Sets message type to HTML. #### Tags:
access: | public
#### Parameters:
bool | $bool |
[ Top ] ### method IsMail [line 299]
`void IsMail( )`
Sets Mailer to send message using PHP mail() function. #### Tags:
access: | public
[ Top ] ### method IsQmail [line 315]
`void IsQmail( )`
Sets Mailer to send message using the qmail MTA. #### Tags:
access: | public
[ Top ] ### method IsSendmail [line 307]
`void IsSendmail( )`
Sets Mailer to send message using the $Sendmail program. #### Tags:
access: | public
[ Top ] ### method IsSMTP [line 291]
`void IsSMTP( )`
Sets Mailer to send message using SMTP. #### Tags:
access: | public
[ Top ] ### method Lang [line 1667]
`string Lang( $key)`
Returns a message in the appropriate language. #### Tags:
access: | private
Overridden in child classes as: C_mailer::Lang() Returns a message in the appropriate language. #### Parameters:
| $key |
[ Top ] ### method MailSend [line 469]
`bool MailSend( $header, $body)`
Sends mail using the PHP mail() function. #### Tags:
access: | public
#### Parameters:
| $header |
| $body |
[ Top ] ### method MsgHTML [line 1714]
`$message MsgHTML( $message, [ $basedir = ''])`
Evaluates the message and returns modifications for inline images and backgrounds #### Tags:
access: | public
#### Parameters:
| $message |
| $basedir |
[ Top ] ### method SecureHeader [line 1889]
`string SecureHeader( string $str)`
Strips newlines to prevent header injection. #### Tags:
access: | public
#### Parameters:
string | $str | String
[ Top ] ### method Send [line 386]
`bool Send( )`
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. #### Tags:
access: | public
[ Top ] ### method SendmailSend [line 437]
`bool SendmailSend( $header, $body)`
Sends mail using the $Sendmail program. #### Tags:
access: | public
#### Parameters:
| $header |
| $body |
[ Top ] ### method ServerHostname [line 1650]
`string ServerHostname( )`
Returns the server hostname or 'localhost.localdomain' if unknown. #### Tags:
access: | private
[ Top ] ### method set [line 1855]
`void set( string $name, [mixed $value = ''])`
Set (or reset) Class Objects (variables) Usage Example: $page->set('X-Priority', '3'); #### Tags:
access: | public
#### Parameters:
string | $name | Parameter Name
mixed | $value | Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset
[ Top ] ### method SetError [line 1625]
`void SetError( $msg)`
Adds the error message to the error container. Returns void. #### Tags:
access: | private
Overridden in child classes as: C_mailer::SetError() Replace the default SetError #### Parameters:
| $msg |
[ Top ] ### method SetLanguage [line 666]
`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. #### Tags:
access: | public
#### Parameters:
string | $lang_type | Type of language (e.g. Portuguese: "br")
string | $lang_path | Path to the language file directory
[ Top ] ### method SetMessageType [line 1092]
`void SetMessageType( )`
Sets the message type. #### Tags:
access: | public
[ Top ] ### method SetWordWrap [line 851]
`void SetWordWrap( )`
Set the body wrapping. #### Tags:
access: | public
[ Top ] ### method Sign [line 1903]
`void Sign( $cert_filename, string $key_filename, string $key_pass)`
Set the private key file and password to sign the message. #### Tags:
access: | public
#### Parameters:
string | $key_filename | Parameter File Name
string | $key_pass | Password for private key
| $cert_filename |
[ Top ] ### method SmtpClose [line 648]
`void SmtpClose( )`
Closes the active SMTP session if one exists. #### Tags:
access: | public
[ Top ] ### method SmtpConnect [line 586]
`bool SmtpConnect( )`
Initiates a connection to an SMTP server. Returns false if the operation failed. #### Tags:
access: | public
[ Top ] ### method SmtpSend [line 519]
`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. #### Tags:
access: | public
#### Parameters:
| $header |
| $body |
[ Top ] ### method TextLine [line 1121]
`string TextLine( $value)`
Returns a formatted mail line. #### Tags:
access: | public
#### Parameters:
| $value |
[ Top ] ### method UTF8CharBoundary [line 813]
`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. #### Tags:
access: | public
#### Parameters:
string | $encodedText | utf-8 QP text
int | $maxLength | find last character boundary prior to this length
[ Top ] ### method WrapText [line 731]
`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. #### Tags:
access: | public
#### Parameters:
| $message |
| $length |
| $qp_mode |
[ Top ] ### method _mime_types [line 1751]
`mime _mime_types( [ $ext = ''])`
Gets the mime type of the embedded or inline image #### Tags:
return: | type of ext
access: | public
#### Parameters:
| $ext |
[ Top ] Documentation generated on Wed, 26 Aug 2009 09:06:47 +0200 by phpDocumentor 1.4.1