Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: PHPMailer

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Element index for package PHPMailer

Other package element indexes


a b c d e f h i m n p q r s t u v w
a
Variable $AltBody
PHPMailer::$AltBody in phpmailer.php
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.
Method AddAddress
PHPMailer::AddAddress() in phpmailer.php
Adds a "To" address.
Method AddAttachment
PHPMailer::AddAttachment() in phpmailer.php
Adds an attachment from a path on the filesystem.
Method AddBCC
PHPMailer::AddBCC() in phpmailer.php
Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Method AddCC
PHPMailer::AddCC() in phpmailer.php
Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Method AddCustomHeader
PHPMailer::AddCustomHeader() in phpmailer.php
Adds a custom header.
Method AddEmbeddedImage
PHPMailer::AddEmbeddedImage() in phpmailer.php
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".
Method AddReplyTo
PHPMailer::AddReplyTo() in phpmailer.php
Adds a "Reply-to" address.
Method AddStringAttachment
PHPMailer::AddStringAttachment() in phpmailer.php
Adds a string or binary attachment (non-filesystem) to the list.
Method Authenticate
SMTP::Authenticate() in smtp.php
Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
b
Variable $Body
PHPMailer::$Body in phpmailer.php
Sets the Body of the message. This can be either an HTML or text body.
c
Variable $CharSet
PHPMailer::$CharSet in phpmailer.php
Sets the CharSet of the message.
Variable $ConfirmReadingTo
PHPMailer::$ConfirmReadingTo in phpmailer.php
Sets the email address that a reading confirmation will be sent.
Variable $ContentType
PHPMailer::$ContentType in phpmailer.php
Sets the Content-type of the message.
Variable $CRLF
SMTP::$CRLF in smtp.php
SMTP reply line ending
Method ClearAddresses
PHPMailer::ClearAddresses() in phpmailer.php
Clears all recipients assigned in the TO array. Returns void.
Method ClearAllRecipients
PHPMailer::ClearAllRecipients() in phpmailer.php
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Method ClearAttachments
PHPMailer::ClearAttachments() in phpmailer.php
Clears all previously set filesystem, string, and binary attachments. Returns void.
Method ClearBCCs
PHPMailer::ClearBCCs() in phpmailer.php
Clears all recipients assigned in the BCC array. Returns void.
Method ClearCCs
PHPMailer::ClearCCs() in phpmailer.php
Clears all recipients assigned in the CC array. Returns void.
Method ClearCustomHeaders
PHPMailer::ClearCustomHeaders() in phpmailer.php
Clears all custom headers. Returns void.
Method ClearReplyTos
PHPMailer::ClearReplyTos() in phpmailer.php
Clears all recipients assigned in the ReplyTo array. Returns void.
Method Close
SMTP::Close() in smtp.php
Closes the socket and cleans up the state of the class.
Method Connect
SMTP::Connect() in smtp.php
Connect to the server specified on the port specified.
d
Variable $do_debug
SMTP::$do_debug in smtp.php
Sets whether debugging is turned on
Method Data
SMTP::Data() in smtp.php
Issues a data command and sends the msg_data to the server
e
Variable $Encoding
PHPMailer::$Encoding in phpmailer.php
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Variable $ErrorInfo
PHPMailer::$ErrorInfo in phpmailer.php
Holds the most recent mailer error message.
Method Expand
SMTP::Expand() in smtp.php
Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.
f
Variable $From
PHPMailer::$From in phpmailer.php
Sets the From email address for the message.
Variable $FromName
PHPMailer::$FromName in phpmailer.php
Sets the From name of the message.
h
Variable $Helo
PHPMailer::$Helo in phpmailer.php
Sets the SMTP HELO of the message (Default is $Hostname).
Variable $Host
PHPMailer::$Host in phpmailer.php
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").
Variable $Hostname
PHPMailer::$Hostname in phpmailer.php
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'.
Method Hello
SMTP::Hello() in smtp.php
Sends the HELO command to the smtp server.
Method Help
SMTP::Help() in smtp.php
Gets help information on the keyword specified. If the keyword
i
Method IsError
PHPMailer::IsError() in phpmailer.php
Returns true if an error occurred.
Method IsHTML
PHPMailer::IsHTML() in phpmailer.php
Sets message type to HTML.
Method IsMail
PHPMailer::IsMail() in phpmailer.php
Sets Mailer to send message using PHP mail() function.
Method IsQmail
PHPMailer::IsQmail() in phpmailer.php
Sets Mailer to send message using the qmail MTA.
Method IsSendmail
PHPMailer::IsSendmail() in phpmailer.php
Sets Mailer to send message using the $Sendmail program.
Method IsSMTP
PHPMailer::IsSMTP() in phpmailer.php
Sets Mailer to send message using SMTP.
m
Variable $Mailer
PHPMailer::$Mailer in phpmailer.php
Method to send mail: ("mail", "sendmail", or "smtp").
Method Mail
SMTP::Mail() in smtp.php
Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.
n
Method Noop
SMTP::Noop() in smtp.php
Sends the command NOOP to the SMTP server.
p
Variable $Password
PHPMailer::$Password in phpmailer.php
Sets SMTP password.
Variable $PluginDir
PHPMailer::$PluginDir in phpmailer.php
Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.
Variable $Port
PHPMailer::$Port in phpmailer.php
Sets the default SMTP server port.
Variable $Priority
PHPMailer::$Priority in phpmailer.php
Email priority (1 = High, 3 = Normal, 5 = low).
Class PHPMailer
PHPMailer in phpmailer.php
PHPMailer - PHP email transport class
File phpmailer.php
phpmailer.php in phpmailer.php
q
Method Quit
SMTP::Quit() in smtp.php
Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.
r
Method Recipient
SMTP::Recipient() in smtp.php
Sends the command RCPT to the SMTP server with the TO: argument of $to.
Method Reset
SMTP::Reset() in smtp.php
Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.
s
Variable $Sender
PHPMailer::$Sender in phpmailer.php
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.
Variable $Sendmail
PHPMailer::$Sendmail in phpmailer.php
Sets the path of the sendmail program.
Variable $SMTPAuth
PHPMailer::$SMTPAuth in phpmailer.php
Sets SMTP authentication. Utilizes the Username and Password variables.
Variable $SMTPDebug
PHPMailer::$SMTPDebug in phpmailer.php
Sets SMTP class debugging on or off.
Variable $SMTPKeepAlive
PHPMailer::$SMTPKeepAlive in phpmailer.php
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().
Variable $SMTP_PORT
SMTP::$SMTP_PORT in smtp.php
SMTP server port
Variable $Subject
PHPMailer::$Subject in phpmailer.php
Sets the Subject of the message.
File smtp.php
smtp.php in smtp.php
Method Send
SMTP::Send() in smtp.php
Starts a mail transaction from the email address specified in
Method Send
PHPMailer::Send() in phpmailer.php
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.
Method SendAndMail
SMTP::SendAndMail() in smtp.php
Starts a mail transaction from the email address specified in
Method SendOrMail
SMTP::SendOrMail() in smtp.php
Starts a mail transaction from the email address specified in
Method SetLanguage
PHPMailer::SetLanguage() in phpmailer.php
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
Constructor SMTP
SMTP::SMTP() in smtp.php
Initialize the class so that the data is in a known state.
Class SMTP
SMTP in smtp.php
SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.
Method SmtpClose
PHPMailer::SmtpClose() in phpmailer.php
Closes the active SMTP session if one exists.
t
Variable $Timeout
PHPMailer::$Timeout in phpmailer.php
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
Method Turn
SMTP::Turn() in smtp.php
This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future
u
Variable $Username
PHPMailer::$Username in phpmailer.php
Sets SMTP username.
v
Variable $Version
PHPMailer::$Version in phpmailer.php
Holds PHPMailer version.
Method Verify
SMTP::Verify() in smtp.php
Verifies that the name is recognized by the server.
w
Variable $WordWrap
PHPMailer::$WordWrap in phpmailer.php
Sets word wrapping on the body of the message to a given number of characters.
a b c d e f h i m n p q r s t u v w
Documentation generated on Mon, 05 Mar 2007 20:51:48 +0000 by phpDocumentor 1.3.1