PHPMailer

# Class: C_mailer Source Location: /shared/code/tce_class_mailer.php
### Class Overview
    PHPMailer
       |
       --C_mailer
C_mailer - PHPMailer class extension #### Author(s): Nicola Asuni #### Version: $Id: class.phpmailer.php 447 2009-05-25 01:36:38Z codeworxtech $ #### Copyright: Copyright © 2004-2010, Nicola Asuni - Tecnick.com S.r.l. - ITALY - www.tecnick.com - info@tecnick.com | ### Variables $language | ### Methods Lang SetError ValidateAddress
### Inherited Constants #### Class: PHPMailer PHPMailer::STOP_CONTINUE PHPMailer::STOP_CRITICAL PHPMailer::STOP_MESSAGE | ### Inherited Variables #### Class: PHPMailer PHPMailer::$action_function PHPMailer::$all_recipients PHPMailer::$AltBody PHPMailer::$attachment PHPMailer::$bcc PHPMailer::$Body PHPMailer::$boundary PHPMailer::$cc PHPMailer::$CharSet PHPMailer::$ConfirmReadingTo PHPMailer::$ContentType PHPMailer::$CustomHeader PHPMailer::$DKIM_domain PHPMailer::$DKIM_identity PHPMailer::$DKIM_private PHPMailer::$DKIM_selector PHPMailer::$Encoding PHPMailer::$ErrorInfo PHPMailer::$error_count PHPMailer::$exceptions PHPMailer::$From PHPMailer::$FromName PHPMailer::$Helo PHPMailer::$Host PHPMailer::$Hostname PHPMailer::$LE PHPMailer::$Mailer PHPMailer::$MessageID PHPMailer::$message_type PHPMailer::$Password PHPMailer::$PluginDir PHPMailer::$Port PHPMailer::$Priority PHPMailer::$ReplyTo PHPMailer::$Sender PHPMailer::$Sendmail PHPMailer::$sign_cert_file PHPMailer::$sign_key_file PHPMailer::$sign_key_pass PHPMailer::$SingleTo PHPMailer::$SingleToArray PHPMailer::$smtp PHPMailer::$SMTPAuth PHPMailer::$SMTPDebug PHPMailer::$SMTPKeepAlive PHPMailer::$SMTPSecure PHPMailer::$Subject PHPMailer::$Timeout PHPMailer::$to PHPMailer::$Username PHPMailer::$Version PHPMailer::$WordWrap | ### Inherited Methods #### Class: PHPMailer PHPMailer::__construct() Constructor PHPMailer::AddAddress() Adds a "To" address. PHPMailer::AddAnAddress() Adds an address to one of the recipient arrays PHPMailer::AddAttachment() Adds an attachment from a path on the filesystem. PHPMailer::AddBCC() Adds a "Bcc" address. PHPMailer::AddCC() Adds a "Cc" address. PHPMailer::AddCustomHeader() Adds a custom header. PHPMailer::AddEmbeddedImage() 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". PHPMailer::AddrAppend() Creates recipient headers. PHPMailer::AddReplyTo() Adds a "Reply-to" address. PHPMailer::AddrFormat() Formats an address correctly. PHPMailer::AddStringAttachment() Adds a string or binary attachment (non-filesystem) to the list. PHPMailer::AttachAll() Attaches all fs, string, and binary attachments to the message. PHPMailer::Base64EncodeWrapMB() Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character. PHPMailer::ClearAddresses() Clears all recipients assigned in the TO array. Returns void. PHPMailer::ClearAllRecipients() Clears all recipients assigned in the TO, CC and BCC array. Returns void. PHPMailer::ClearAttachments() Clears all previously set filesystem, string, and binary attachments. Returns void. PHPMailer::ClearBCCs() Clears all recipients assigned in the BCC array. Returns void. PHPMailer::ClearCCs() Clears all recipients assigned in the CC array. Returns void. PHPMailer::ClearCustomHeaders() Clears all custom headers. Returns void. PHPMailer::ClearReplyTos() Clears all recipients assigned in the ReplyTo array. Returns void. PHPMailer::CreateBody() Assembles the message body. Returns an empty string on failure. PHPMailer::CreateHeader() Assembles message header. PHPMailer::DKIM_Add() Create the DKIM header, body, as new header PHPMailer::DKIM_BodyC() Generate DKIM Canonicalization Body PHPMailer::DKIM_HeaderC() Generate DKIM Canonicalization Header PHPMailer::DKIM_QP() Set the private key file and password to sign the message. PHPMailer::DKIM_Sign() Generate DKIM signature PHPMailer::doCallback() PHPMailer::EncodeFile() Encodes attachment in requested format. PHPMailer::EncodeHeader() Encode a header string to best (shortest) of Q, B, quoted or none. PHPMailer::EncodeQ() Encode string to q encoding. PHPMailer::EncodeQP() Encode string to RFC2045 (6.7) quoted-printable format PHPMailer::EncodeQPphp() Encode string to quoted-printable. PHPMailer::EncodeString() Encodes string to requested format. PHPMailer::EndBoundary() Returns the end of a message boundary. PHPMailer::FixEOL() Changes every end of line from CR or LF to CRLF. PHPMailer::GetAttachments() Return the current array of attachments PHPMailer::GetBoundary() Returns the start of a message boundary. PHPMailer::GetMailMIME() Returns the message MIME. PHPMailer::GetTranslations() Return the current array of language strings PHPMailer::HasMultiBytes() Checks if a string contains multibyte characters. PHPMailer::HeaderLine() Returns a formatted header line. PHPMailer::InlineImageExists() Returns true if an inline attachment is present. PHPMailer::IsError() Returns true if an error occurred. PHPMailer::IsHTML() Sets message type to HTML. PHPMailer::IsMail() Sets Mailer to send message using PHP mail() function. PHPMailer::IsQmail() Sets Mailer to send message using the qmail MTA. PHPMailer::IsSendmail() Sets Mailer to send message using the $Sendmail program. PHPMailer::IsSMTP() Sets Mailer to send message using SMTP. PHPMailer::Lang() Returns a message in the appropriate language. PHPMailer::MailSend() Sends mail using the PHP mail() function. PHPMailer::MsgHTML() Evaluates the message and returns modifications for inline images and backgrounds PHPMailer::RFCDate() Returns the proper RFC 822 formatted date. PHPMailer::SecureHeader() Strips newlines to prevent header injection. PHPMailer::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. PHPMailer::SendmailSend() Sends mail using the $Sendmail program. PHPMailer::ServerHostname() Returns the server hostname or 'localhost.localdomain' if unknown. PHPMailer::set() Set (or reset) Class Objects (variables) PHPMailer::SetError() Adds the error message to the error container. PHPMailer::SetFrom() Set the From and FromName properties PHPMailer::SetLanguage() Sets the language for all class error messages. PHPMailer::SetMessageType() Sets the message type. PHPMailer::SetWordWrap() Set the body wrapping. PHPMailer::Sign() Set the private key file and password to sign the message. PHPMailer::SmtpClose() Closes the active SMTP session if one exists. PHPMailer::SmtpConnect() Initiates a connection to an SMTP server. PHPMailer::SmtpSend() Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input. PHPMailer::TextLine() Returns a formatted mail line. PHPMailer::UTF8CharBoundary() Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string. PHPMailer::ValidateAddress() Check that a string looks roughly like an email address should PHPMailer::WrapText() Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable. PHPMailer::_mime_types() Gets the MIME type of the embedded or inline image
### Class Details [line 74] C_mailer - PHPMailer class extension #### Tags:
author: | Nicola Asuni
version: | $Id: class.phpmailer.php 447 2009-05-25 01:36:38Z codeworxtech $
copyright: | Copyright © 2004-2010, Nicola Asuni - Tecnick.com S.r.l. - ITALY - www.tecnick.com - info@tecnick.com
link: | www.tecnick.com
since: | 2005-02-24
license: | GNU Affero General Public License
[ Top ] ### Class Variables #### $language = [line 80] language array #### Tags:
var: | array
access: | public
Type: | string
Overrides: | Array
[ Top ] ### Class Methods ### static method ValidateAddress [line 120]
`static boolean ValidateAddress( string $address)`
Check that a string looks roughly like an email address should (override original ValidateAddress method). Conforms approximately to RFC2822 #### Tags:
link: | Original pattern found here
access: | public
Overrides PHPMailer::ValidateAddress() (Check that a string looks roughly like an email address should) #### Parameters:
string | $address | The email address to check
[ Top ] ### method Lang [line 102]
`string Lang( $key)`
Returns a message in the appropriate language. (override original Lang method). #### Tags:
var: | language key
access: | protected
Overrides PHPMailer::Lang() (Returns a message in the appropriate language.) #### Parameters:
| $key |
[ Top ] ### method SetError [line 88]
`void SetError( $msg)`
Replace the default SetError #### Tags:
var: | error message
access: | public
Overrides PHPMailer::SetError() (Adds the error message to the error container.) #### Parameters:
| $msg |
[ Top ] Documentation generated on Mon, 06 Dec 2010 12:03:03 +0100 by phpDocumentor 1.4.3