Joomla! Platform 12.1

Joomla! Platform API

Packages

Package: PHPMailer

License

Content on this site is copyright © 2005 - 2012 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

PHPMailer

Description

PHPMailer - PHP email transport class

NOTE: Requires PHP version 5 or later

author: Jim Jagielski
author: Andy Prevost
author: Marcus Bointon
version: $Id: class.phpmailer.php 450 2010-06-23 16:46:33Z coolbru $
copyright: 2004 - 2009 Andy Prevost
copyright: 2010 - 2012 Jim Jagielski
license: GNU Lesser General Public License

Located in /libraries/phpmailer/phpmailer.php (line 40)

 PHPMailer

Direct descendents

Class	Description
JMail	Email Class. Provides a common interface to send email from the Joomla! Platform

Class Constant Summary

STOP_CONTINUE = 1

STOP_CRITICAL = 2

STOP_MESSAGE = 0

Variable Summary

string $action_function

mixed $all_recipients

string $AltBody

mixed $attachment

mixed $bcc

string $Body

mixed $boundary

mixed $cc

string $CharSet

string $ConfirmReadingTo

string $ContentType

mixed $CustomHeader

string $DKIM_domain

string $DKIM_identity

string $DKIM_passphrase

string $DKIM_private

string $DKIM_selector

string $Encoding

string $ErrorInfo

mixed $error_count

mixed $exceptions

string $From

string $FromName

string $Helo

string $Host

string $Hostname

mixed $language

string $LE

string $Mailer

string $MessageID

mixed $message_type

string $MIMEBody

string $MIMEHeader

string $Password

string $PluginDir

int $Port

int $Priority

mixed $ReplyTo

string $Sender

string $Sendmail

string $SentMIMEMessage

mixed $sign_cert_file

mixed $sign_key_file

mixed $sign_key_pass

bool $SingleTo

bool $SingleToArray

mixed $smtp

bool $SMTPAuth

bool $SMTPDebug

bool $SMTPKeepAlive

string $SMTPSecure

string $Subject

int $Timeout

mixed $to

string $Username

string $Version

int $WordWrap

string $XMailer

Method Summary

static string RFCDate ()

static boolean ValidateAddress (string $address)

static string _mime_types ([string $ext = ''])

PHPMailer __construct ([boolean $exceptions = false])

boolean AddAddress (string $address, [string $name = ''])

boolean AddAnAddress (string $kind, string $address, [string $name = ''])

bool AddAttachment (string $path, [string $name = ''], [string $encoding = 'base64'], [string $type = 'application/octet-stream'])

boolean AddBCC (string $address, [string $name = ''])

boolean AddCC (string $address, [string $name = ''])

void AddCustomHeader ( $custom_header)

bool AddEmbeddedImage (string $path, string $cid, [string $name = ''], [string $encoding = 'base64'], [string $type = 'application/octet-stream'])

string AddrAppend ( $type, $addr)

boolean AddReplyTo (string $address, [string $name = ''])

string AddrFormat ( $addr)

void AddStringAttachment (string $string, string $filename, [string $encoding = 'base64'], [string $type = 'application/octet-stream'])

void AddStringEmbeddedImage ( $string, $cid, [ $filename = ''], [ $encoding = 'base64'], [ $type = 'application/octet-stream'])

void AlternativeExists ()

string AttachAll ( $disposition_type, $boundary)

void AttachmentExists ()

string Base64EncodeWrapMB (string $str)

void ClearAddresses ()

void ClearAllRecipients ()

void ClearAttachments ()

void ClearBCCs ()

void ClearCCs ()

void ClearCustomHeaders ()

void ClearReplyTos ()

string CreateBody ()

string CreateHeader ()

void DKIM_Add (string $headers_line, string $subject, string $body)

void DKIM_BodyC (string $body)

void DKIM_HeaderC (string $s)

void DKIM_QP ( $txt, string $key_filename, string $key_pass)

void DKIM_Sign (string $s)

void doCallback ( $isSent, $to, $cc, $bcc, $subject, $body)

string EncodeFile (string $path, [string $encoding = 'base64'])

string EncodeHeader ( $str, [ $position = 'text'])

string EncodeQ (string $str, [string $position = 'text'])

string EncodeQP (string $string, [integer $line_max = 76], [boolean $space_conv = false])

string EncodeQPphp ([ $input = ''], [integer $line_max = 76], [ $space_conv = false], string $string)

string EncodeString (string $str, [string $encoding = 'base64'])

string EndBoundary ( $boundary)

string FixEOL ( $str)

array GetAttachments ()

string GetBoundary ( $boundary, $charSet, $contentType, $encoding)

string GetMailMIME ()

string GetSentMIMEMessage ()

array GetTranslations ()

bool HasMultiBytes (string $str)

string HeaderLine ( $name, $value)

bool InlineImageExists ()

bool IsError ()

void IsHTML ([bool $ishtml = true])

void IsMail ()

void IsQmail ()

void IsSendmail ()

void IsSMTP ()

string Lang ( $key)

bool MailSend (string $header, string $body)

$message MsgHTML ( $message, [ $basedir = ''])

void PostSend ()

void PreSend ()

string SecureHeader (string $str)

bool Send ()

bool SendmailSend (string $header, string $body)

string ServerHostname ()

void set (string $name, [mixed $value = ''])

void SetError ( $msg)

boolean SetFrom (string $address, [string $name = ''], [ $auto = 1])

void SetLanguage ([string $langcode = 'en'], [string $lang_path = 'language/'])

void SetMessageType ()

void SetWordWrap ()

void Sign ( $cert_filename, string $key_filename, string $key_pass)

void SmtpClose ()

bool SmtpConnect ()

bool SmtpSend (string $header, string $body)

string TextLine ( $value)

int UTF8CharBoundary (string $encodedText, int $maxLength)

string WrapText (string $message, integer $length, [boolean $qp_mode = false])

Variables

string $action_function = '' (line 321)

Callback Action function name

the function that handles the result of the send email action. Parameters: bool $result result of the send action string $to email address of the recipient string $cc cc email addresses string $bcc bcc email addresses string $subject the subject string $body the email body

access: public

mixed $all_recipients = array() (line 344)

access: protected

string $AltBody = '' (line 116)

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.

access: public

mixed $attachment = array() (line 345)

access: protected

mixed $bcc = array() (line 342)

access: protected

string $Body = '' (line 107)

Sets the Body of the message. This can be either an HTML or text body.

If HTML then run IsHTML(true).

access: public

mixed $boundary = array() (line 348)

access: protected

mixed $cc = array() (line 341)

access: protected

string $CharSet = 'iso-8859-1' (line 56)

Sets the CharSet of the message.

access: public

Redefined in descendants as:

JMail::$CharSet

string $ConfirmReadingTo = '' (line 169)

Sets the email address that a reading confirmation will be sent.

access: public

string $ContentType = 'text/plain' (line 62)

Sets the Content-type of the message.

access: public

mixed $CustomHeader = array() (line 346)

access: protected

string $DKIM_domain = '' (line 301)