inc/classes/main/commands/web/class_WebLoginFailedCommand.php -text
inc/classes/main/commands/web/class_WebLogoutDoneCommand.php -text
inc/classes/main/commands/web/class_WebRegisterCommand.php -text
+inc/classes/main/commands/web/class_WebResendLinkCommand.php -text
inc/classes/main/compressor/.htaccess -text
inc/classes/main/compressor/class_Bzip2Compressor.php -text
inc/classes/main/compressor/class_GzipCompressor.php -text
inc/classes/main/filter/verifier/class_PasswordVerifierFilter.php -text
inc/classes/main/filter/verifier/class_UserNameVerifierFilter.php -text
inc/classes/main/filter/verifier/class_UserStatusVerifierFilter.php -text
+inc/classes/main/filter/verifier/class_UserUnconfirmedVerifierFilter.php -text
inc/classes/main/helper/.htaccess -text
inc/classes/main/helper/class_ -text
inc/classes/main/helper/class_BaseHelper.php -text
inc/classes/middleware/io/.htaccess -text
inc/classes/middleware/io/class_FileIoHandler.php -text
inc/classes/third_party/.htaccess -text
+inc/classes/third_party/php_mailer/.htaccess -text
+inc/classes/third_party/php_mailer/ChangeLog.txt -text
inc/classes/third_party/php_mailer/LICENSE -text
+inc/classes/third_party/php_mailer/README -text
inc/classes/third_party/php_mailer/class.phpmailer.php -text
inc/classes/third_party/php_mailer/class.pop3.php -text
inc/classes/third_party/php_mailer/class.smtp.php -text
+inc/classes/third_party/php_mailer/docs/extending.html -text
+inc/classes/third_party/php_mailer/docs/faq.html -text
+inc/classes/third_party/php_mailer/docs/pop3_article.txt -text
+inc/classes/third_party/php_mailer/docs/use_gmail.txt -text
+inc/classes/third_party/php_mailer/examples/contents.html -text
+inc/classes/third_party/php_mailer/examples/images/bkgrnd.gif -text
+inc/classes/third_party/php_mailer/examples/images/phpmailer.gif -text
+inc/classes/third_party/php_mailer/examples/images/phpmailer.png -text
+inc/classes/third_party/php_mailer/examples/images/phpmailer_mini.gif -text
+inc/classes/third_party/php_mailer/examples/index.html -text
+inc/classes/third_party/php_mailer/examples/pop3_before_smtp_test.php -text
+inc/classes/third_party/php_mailer/examples/test_gmail.php -text
+inc/classes/third_party/php_mailer/examples/test_mail.php -text
+inc/classes/third_party/php_mailer/examples/test_sendmail.php -text
+inc/classes/third_party/php_mailer/examples/test_smtp.php -text
+inc/classes/third_party/php_mailer/language/.htaccess -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-br.php -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-ca.php -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-cz.php -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-ru.php -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-se.php -text
inc/classes/third_party/php_mailer/language/phpmailer.lang-tr.php -text
+inc/classes/third_party/php_mailer/phpdoc/PHPMailer/PHPMailer.html -text
+inc/classes/third_party/php_mailer/phpdoc/PHPMailer/SMTP.html -text
+inc/classes/third_party/php_mailer/phpdoc/PHPMailer/_class_phpmailer_php.html -text
+inc/classes/third_party/php_mailer/phpdoc/PHPMailer/_class_smtp_php.html -text
+inc/classes/third_party/php_mailer/phpdoc/blank.html -text
+inc/classes/third_party/php_mailer/phpdoc/classtrees_PHPMailer.html -text
+inc/classes/third_party/php_mailer/phpdoc/elementindex.html -text
+inc/classes/third_party/php_mailer/phpdoc/elementindex_PHPMailer.html -text
+inc/classes/third_party/php_mailer/phpdoc/errors.html -text
+inc/classes/third_party/php_mailer/phpdoc/index.html -text
+inc/classes/third_party/php_mailer/phpdoc/li_PHPMailer.html -text
+inc/classes/third_party/php_mailer/phpdoc/media/banner.css -text
+inc/classes/third_party/php_mailer/phpdoc/media/stylesheet.css -text
+inc/classes/third_party/php_mailer/phpdoc/packages.html -text
+inc/classes/third_party/php_mailer/test/phpmailer_test.php -text
+inc/classes/third_party/php_mailer/test/phpunit.php -text
+inc/classes/third_party/php_mailer/test/test.png -text
inc/config.php -text
inc/config/.htaccess -text
inc/config/class_FrameworkConfiguration.php -text
// CFG: USER-STATUS-CONFIRMED
$cfg->setConfigEntry('user_status_confirmed', "CONFIRMED");
-// CFG: LOGIN-HELPER
+// CFG: LOGIN-HELPER-CLASS
$cfg->setConfigEntry('login_helper_class', "ShipSimuLoginHelper");
-// CFG: LOGIN-METHOD
+// CFG: AUTH-METHOD-CLASS
$cfg->setConfigEntry('auth_method_class', "CookieAuth");
// CFG: APP-LOGIN-URL
// CFG: LOGIN-USER-STATUS-URL
$cfg->setConfigEntry('login_user_status_url', "index.php?app=ship-simu&page=login_area&action=status_problem");
+// CFG: LOGIN-USER-UNCONFIRMED-URL
+$cfg->setConfigEntry('login_user_unconfirmed_url', "index.php?app=ship-simu&page=status_unconfirmed_problem");
+
// CFG: LOGIN-DEFAULT-ACTION
$cfg->setConfigEntry('login_default_action', "welcome");
* @param $requestInstance An instance of a Requestable class
* @param $responseInstance An instance of a Responseable class
* @return void
- * @throws UserAuthMethodException If wether username nor email login
- * was detected
- * @throws MissingMethodException If a method was not found in the
- * User class
* @throws UserPasswordMismatchException If the supplied password did not
* match with the stored password
* @todo We need to add something here which will make more than one
$method = null;
$data = "";
- // Detect login method (username or email) and try to get a userinstance
- if (!is_null($requestInstance->getRequestElement('username'))) {
- // Username found!
- $method = "createUserByUsername";
- $data = $requestInstance->getRequestElement('username');
- } elseif (!is_null($requestInstance->getRequestElement('email'))) {
- // Email found!
- $method = "createUserByEmail";
- $data = $requestInstance->getRequestElement('email');
- }
-
- // Is a method detected?
- if (is_null($method)) {
- // Then abort here
- throw new UserAuthMethodException($this, self::EXCEPTION_MISSING_METHOD);
- } elseif (!method_exists($this->getConfigInstance()->readConfig('user_class'), $method)) {
- // The method is invalid!
- throw new MissingMethodException(array($this, $method), self::EXCEPTION_MISSING_METHOD);
- }
-
// Get a instance of the registry
$userInstance = Registry::getRegistry()->getInstance('user');
// Is there an instance?
if (is_null($userInstance)) {
// Get a user instance
- $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), $method), array($data));
+ $userInstance = User::createUserByRequest($requestInstance);
// Remember this new instance in registry
Registry::getRegistry()->addInstance($userInstance);
// Add submit button or notice
if ($helper->ifUserAccountUnconfirmed()) {
+ // Add submit button
+ $helper->addInputHiddenFieldWithDefault("email");
$helper->addInputSubmitButton("Bestätigungslink erneut aussenden");
} elseif ($helper->ifUserAccountLocked()) {
+ // Account is locked
$helper->addFormNote("Dein Account wurde gesperrt! Grund der Sperre:
<span id=\"lock_reason\">".$helper->getField('lock_reason')."</span>
Bitte melde dich beim Support, damit dieser dir weiterhelfen kann."
);
} elseif ($helper->ifUserAccountGuest()) {
+ // Account is guest account
$helper->addFormNote("Gästeaccounts sind in der Funktionalität
leicht eingeschränkt. Bitte melde dich an, damit du ein
vollwertiges Account bekommst."
*/
public function __construct (array $msgArray, $code) {
// Add a message around the missing class
- $message = sprintf("[%s:%d] Invalid command <span id=\"exception_reason\">%s</span> detected.",
+ $message = sprintf("[%s:%d] Invalid command <span id=\"exception_reason\">%s (class %s)</span> detected.",
$msgArray[0]->__toString(),
$this->getLine(),
- $msgArray[1]
+ $msgArray[1],
+ $msgArray[0]->getClassName()
);
// Call parent constructor
// ... and all variables. This should be merged together in a pattern
// to make things easier. A cache mechanism should be added between
// these two calls to cache compiled templates.
- //$templateInstance->debugInstance();
$templateInstance->compileVariables();
// Get the content back from the template engine and put it in the response class
--- /dev/null
+<?php
+/**
+ * A command class for resending the confirmation link
+ *
+ * @author Roland Haeder <webmaster@ship-simu.org>
+ * @version 0.0.0
+ * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class WebResendLinkCommand extends BaseCommand implements Commandable {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Set special description
+ $this->setObjectDescription("Command for resending confirmation link");
+
+ // Create unique ID number
+ $this->generateUniqueId();
+
+ // Clean up a little
+ $this->removeSystemArray();
+ }
+
+ /**
+ * Creates an instance of this class
+ *
+ * @param $resolverInstance An instance of a command resolver class
+ * @return $commandInstance An instance a prepared command class
+ */
+ public final static function createWebResendLinkCommand (CommandResolver $resolverInstance) {
+ // Get new instance
+ $commandInstance = new WebResendLinkCommand();
+
+ // Set the application instance
+ $commandInstance->setResolverInstance($resolverInstance);
+
+ // Return the prepared instance
+ return $commandInstance;
+ }
+
+ /**
+ * Executes the given command with given request and response objects
+ *
+ * @param $requestInstance An instance of a class with an Requestable interface
+ * @param $responseInstance An instance of a class with an Responseable interface
+ * @return void
+ */
+ public function execute (Requestable $requestInstance, Responseable $responseInstance) {
+ $this->debugInstance();
+ }
+
+ /**
+ * Adds extra filters to the given controller instance
+ *
+ * @param $controllerInstance A controller instance
+ * @param $requestInstance An instance of a class with an Requestable interface
+ * @return void
+ */
+ public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
+ // Filter for checking if account is unconfirmed
+ $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_unconfirmed_class'));
+ }
+}
+
+// [EOF]
+?>
--- /dev/null
+<?php
+/**
+ * A filter for checking if the user status is UNCONFIRMED
+ *
+ * @author Roland Haeder <webmaster@ship-simu.org>
+ * @version 0.0.0
+ * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class UserUnconfirmedVerifierFilter extends BaseFrameworkSystem implements Filterable {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Set part description
+ $this->setObjectDescription("A filter for checking if the user account is unconfirmed");
+
+ // Create unique ID number
+ $this->generateUniqueId();
+
+ // Clean up a little
+ $this->removeNumberFormaters();
+ $this->removeSystemArray();
+ }
+
+ /**
+ * Creates an instance of this filter class
+ *
+ * @return $filterInstance An instance of this filter class
+ */
+ public final static function createUserUnconfirmedVerifierFilter () {
+ // Get a new instance
+ $filterInstance = new UserUnconfirmedVerifierFilter();
+
+ // Return the instance
+ return $filterInstance;
+ }
+
+ /**
+ * Executes the filter with given request and response objects
+ *
+ * @param $requestInstance An instance of a class with an Requestable interface
+ * @param $responseInstance An instance of a class with an Responseable interface
+ * @return void
+ */
+ public function execute (Requestable $requestInstance, Responseable $responseInstance) {
+ // Get a user instance for comparison
+ $userInstance = User::createUserByRequest($requestInstance);
+
+ // Is the user account confirmed?
+ if ($userInstance->getField('user_status') != $this->getConfigInstance()->readConfig('user_status_unconfirmed')) {
+ // Request is invalid!
+ $requestInstance->requestIsValid(false);
+
+ // Redirect to configured URL
+ $responseInstance->redirectToConfiguredUrl('login_user_unconfirmed_url');
+
+ // Stop processing here
+ exit();
+ } // END - if
+ }
+}
+
+// [EOF]
+?>
$this->addContent($inputContent);
}
+ /**
+ * Add a hidden input tag to the form with pre-loaded default value
+ *
+ * @param $fieldName Input field name
+ * @return void
+ */
+ public function addInputHiddenFieldWithDefault ($fieldName) {
+ // Get the value from instance
+ $fieldValue = call_user_func_array(array($this->valueInstance, "getField"), array($fieldName));
+ //* DEBUG: */ echo __METHOD__.":".$fieldName."=".$fieldValue."<br />\n";
+
+ // Add the text field
+ $this->addInputHiddenField($fieldName, $fieldValue);
+ }
+
/**
* Add a checkbox input tag to the form or throw an exception if it is not
* yet opened. The field's name will be set as id.
} // END - if
// Now, let us create the full name of the action class
- $className = sprintf("%s%sAction",
+ $this->setClassName(sprintf("%s%sAction",
$this->actionPrefix,
$this->convertToClassName($actionName)
- );
+ ));
// Is this class already loaded?
- if (class_exists($className)) {
+ if (class_exists($this->getClassName())) {
// This class does exist. :-)
$isValid = true;
} // END - if
$actionInstance = null;
// Create action class name
- $className = sprintf("Web%sAction",
+ $this->setClassName(sprintf("Web%sAction",
$this->convertToClassName($this->getActionName())
- );
+ ));
// Initiate the action
- $actionInstance = ObjectFactory::createObjectByName($className, array($this));
+ $actionInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
// Return the result
return $actionInstance;
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class BaseResolver extends BaseFrameworkSystem {
+ /**
+ * Class name
+ */
+ private $className = "";
+
// Exception constants
const EXCEPTION_INVALID_COMMAND = 0x0c0;
const EXCEPTION_INVALID_CONTROLLER = 0x0c1;
$this->removeNumberFormaters();
$this->removeSystemArray();
}
+
+ /**
+ * Setter for class name
+ *
+ * @param $className Name of the class
+ * @return void
+ */
+ protected final function setClassName ($className) {
+ $this->className = $className;
+ }
+
+ /**
+ * Getter for class name
+ *
+ * @return $className Name of the class
+ */
+ public final function getClassName () {
+ return $this->className;
+ }
}
// [EOF]
}
// Now, let us create the full name of the command class
- $className = sprintf("%s%sCommand",
+ $this->setClassName(sprintf("%s%sCommand",
$this->commandPrefix,
$this->convertToClassName($commandName)
- );
+ ));
// Is this class already loaded?
- if (class_exists($className)) {
+ if (class_exists($this->getClassName())) {
// This class does exist. :-)
$isValid = true;
} // END - if
/**
* Last successfull resolved command
*/
- private $lastCommandInstance = "";
+ private $lastCommandInstance = null;
/**
* Protected constructor
$commandInstance = null;
// Create command class name
- $className = sprintf("Web%sCommand",
+ $this->setClassName(sprintf("Web%sCommand",
$this->convertToClassName($commandName)
- );
+ ));
// Is this class loaded?
- if (!class_exists($className)) {
+ if (!class_exists($this->getClassName())) {
// Class not found, so try the default one or throw exception
if ($commandName != $defaultCommand) {
// Try the default command
} // END - if
// Initiate the command
- $commandInstance = ObjectFactory::createObjectByName($className, array($this));
+ $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
// Return the result
return $commandInstance;
} // END - if
// Now, let us create the full name of the controller class
- $className = sprintf("%s%sController",
+ $this->setClassName(sprintf("%s%sController",
$this->controllerPrefix,
$this->convertToClassName($controllerName)
- );
+ ));
// Try it hard to get an controller
while (!$isValid) {
// Is this class already loaded?
- if (class_exists($className)) {
+ if (class_exists($this->getClassName())) {
// This class does exist. :-)
$isValid = true;
- } elseif (($className != "WebDefaultController") && ($className != "WebDefaultNewsController")) {
+ } elseif (($this->getClassName() != "WebDefaultController") && ($this->getClassName() != "WebDefaultNewsController")) {
// Do we have news?
if ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) {
// Yes, display news in home then set default controller with news
- $className = "WebDefaultNewsController";
+ $this->setClassName("WebDefaultNewsController");
} else {
// No news at "home" page or non-news page
- $className = "WebDefaultController";
+ $this->setClassName("WebDefaultController");
}
} else {
// All is tried, give it up here
$controllerInstance = null;
// Default controller
- $className = "WebDefaultController";
+ $this->setClassName("WebDefaultController");
// Generate the class name
//* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
if ($controllerName != $defaultController) {
// Create controller class name
- $className = sprintf("Web%sController",
+ $this->setClassName(sprintf("Web%sController",
$this->convertToClassName($controllerName)
- );
+ ));
} elseif ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) {
// Yes, display news in home then set default controller with news
- $className = "WebDefaultNewsController";
+ $this->setClassName("WebDefaultNewsController");
} else {
// No news at "home" page or non-news page
- $className = "WebDefaultController";
+ $this->setClassName("WebDefaultController");
}
- //* DEBUG: */ echo ", controller=".$className."<br />\n";
+ //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
// Is this class loaded?
- if (!class_exists($className)) {
+ if (!class_exists($this->getClassName())) {
// Class not found, so try the default one or throw exception
if ($controllerName != $defaultController) {
// Try the default controller
// Initiate the resolver and controller
$resolverInstance = ObjectFactory::createObjectByConfiguredName('web_cmd_resolver_class', array($controllerName, $this->getApplicationInstance()));
- $controllerInstance = ObjectFactory::createObjectByName($className, array($resolverInstance));
+ $controllerInstance = ObjectFactory::createObjectByName($this->getClassName(), array($resolverInstance));
// Remove resolver
unset($resolverInstance);
return $userInstance;
}
+ /**
+ * Creates a user by a given request instance
+ *
+ * @param $requestInstance An instance of a Requestable class
+ * @return $userInstance An instance of this user class
+ */
+ public final static function createUserByRequest (Requestable $requestInstance) {
+ // Determine if by email or username
+ if (!is_null($requestInstance->getRequestElement('username'))) {
+ // Username supplied
+ $userInstance = self::createUserByUserName($requestInstance->getRequestElement('username'));
+ } elseif (!is_null($requestInstance->getRequestElement('email'))) {
+ // Email supplied
+ $userInstance = self::createUserByEmail($requestInstance->getRequestElement('email'));
+ } else {
+ // Unsupported mode
+ $userInstance = new User();
+ $userInstance->partialStub("We need to add more ways of creating user accounts here.");
+ $userInstance->debugBackTrace();
+ exit();
+ }
+
+ // Return the prepared instance
+ return $userInstance;
+ }
+
/**
* "Getter" for databse entry
*
--- /dev/null
+Deny from all
--- /dev/null
+/*******************************************************************\r
+* The http://phpmailer.codeworxtech.com/ website now carries a few *\r
+* advertisements through the Google Adsense network. Please visit *\r
+* the advertiser sites and help us offset some of our costs. *\r
+* Thanks .... *\r
+********************************************************************/\r
+\r
+ChangeLog\r
+\r
+NOTE: THIS VERSION OF PHPMAILER IS DESIGNED FOR PHP5. IT WILL NOT WORK WITH PHP4.\r
+\r
+Version 2.1 (Wed, June 04 2008)\r
+\r
+** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.\r
+ IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE\r
+ APPRECIATED.\r
+\r
+* added S/MIME functionality (ability to digitally sign emails)\r
+ BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.\r
+ The "Signed Emails" functionality adds the Sign method to pass the private key\r
+ filename and the password to read it, and then email will be sent with\r
+ content-type multipart/signed and with the digital signature attached.\r
+* fully compatible with E_STRICT error level\r
+ - Please note:\r
+ In about half the test environments this development version was subjected\r
+ to, an error was thrown for the date() functions used (line 1565 and 1569).\r
+ This is NOT a PHPMailer error, it is the result of an incorrectly configured\r
+ PHP5 installation. The fix is to modify your 'php.ini' file and include the\r
+ date.timezone = America/New York\r
+ directive, to your own server timezone\r
+ - If you do get this error, and are unable to access your php.ini file:\r
+ In your PHP script, add\r
+ date_default_timezone_set('America/Toronto');\r
+ - do not try to use\r
+ $myVar = date_default_timezone_get();\r
+ as a test, it will throw an error.\r
+* added ability to define path (mainly for embedded images)\r
+ function MsgHTML($message,$basedir='') ... where:\r
+ $basedir is the fully qualified path\r
+* fixed MsgHTML() function:\r
+ - Embedded Images where images are specified by <protocol>:// will not be altered or embedded\r
+* fixed the return value of SMTP exit code ( pclose )\r
+* addressed issue of multibyte characters in subject line and truncating\r
+* added ability to have user specified Message ID\r
+ (default is still that PHPMailer create a unique Message ID)\r
+* corrected unidentified message type to 'application/octet-stream'\r
+* fixed chunk_split() multibyte issue (thanks to Colin Brown, et al).\r
+* added check for added attachments\r
+* enhanced conversion of HTML to text in MsgHTML (thanks to "brunny")\r
+\r
+Version 2.1.0beta2 (Sun, Dec 02 2007)\r
+* implemented updated EncodeQP (thanks to coolbru, aka Marcus Bointon)\r
+* finished all testing, all known bugs corrected, enhancements tested\r
+- note: will NOT work with PHP4.\r
+\r
+please note, this is BETA software\r
+** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS\r
+INTENDED STRICTLY FOR TESTING\r
+\r
+Version 2.1.0beta1\r
+please note, this is BETA software\r
+** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS\r
+INTENDED STRICTLY FOR TESTING\r
+\r
+Version 2.0.0 rc2 (Fri, Nov 16 2007), interim release\r
+* implements new property to control VERP in class.smtp.php\r
+ example (requires instantiating class.smtp.php):\r
+ $mail->do_verp = true;\r
+* POP-before-SMTP functionality included, thanks to Richard Davey\r
+ (see class.pop3.php & pop3_before_smtp_test.php for examples)\r
+* included example showing how to use PHPMailer with GMAIL\r
+* fixed the missing Cc in SendMail() and Mail()\r
+\r
+******************\r
+A note on sending bulk emails:\r
+\r
+If the email you are sending is not personalized, consider using the\r
+"undisclosed-recipient:;" strategy. That is, put all of your recipients\r
+in the Bcc field and set the To field to "undisclosed-recipients:;".\r
+It's a lot faster (only one send) and saves quite a bit on resources.\r
+Contrary to some opinions, this will not get you listed in spam engines -\r
+it's a legitimate way for you to send emails.\r
+\r
+A partial example for use with PHPMailer:\r
+\r
+$mail->AddAddress("undisclosed-recipients:;");\r
+$mail->AddBCC("email1@anydomain.com,email2@anyotherdomain.com,email3@anyalternatedomain.com");\r
+\r
+Many email service providers restrict the number of emails that can be sent\r
+in any given time period. Often that is between 50 - 60 emails maximum\r
+per hour or per send session.\r
+\r
+If that's the case, then break up your Bcc lists into chunks that are one\r
+less than your limit, and put a pause in your script.\r
+*******************\r
+\r
+Version 2.0.0 rc1 (Thu, Nov 08 2007), interim release\r
+* dramatically simplified using inline graphics ... it's fully automated and requires no user input\r
+* added automatic document type detection for attachments and pictures\r
+* added MsgHTML() function to replace Body tag for HTML emails\r
+* fixed the SendMail security issues (input validation vulnerability)\r
+* enhanced the AddAddresses functionality so that the "Name" portion is used in the email address\r
+* removed the need to use the AltBody method (set from the HTML, or default text used)\r
+* set the PHP Mail() function as the default (still support SendMail, SMTP Mail)\r
+* removed the need to set the IsHTML property (set automatically)\r
+* added Estonian language file by Indrek Päri\r
+* added header injection patch\r
+* added "set" method to permit users to create their own pseudo-properties like 'X-Headers', etc.\r
+ example of use:\r
+ $mail->set('X-Priority', '3');\r
+ $mail->set('X-MSMail-Priority', 'Normal');\r
+* fixed warning message in SMTP get_lines method\r
+* added TLS/SSL SMTP support\r
+ example of use:\r
+ $mail = new PHPMailer();\r
+ $mail->Mailer = "smtp";\r
+ $mail->Host = "smtp.example.com";\r
+ $mail->SMTPSecure = "tls"; // option\r
+ //$mail->SMTPSecure = "ssl"; // option\r
+ ...\r
+ $mail->Send();\r
+* PHPMailer has been tested with PHP4 (4.4.7) and PHP5 (5.2.7)\r
+* Works with PHP installed as a module or as CGI-PHP\r
+- NOTE: will NOT work with PHP5 in E_STRICT error mode\r
+\r
+Version 1.73 (Sun, Jun 10 2005)\r
+* Fixed denial of service bug: http://www.cybsec.com/vuln/PHPMailer-DOS.pdf\r
+* Now has a total of 20 translations\r
+* Fixed alt attachments bug: http://tinyurl.com/98u9k\r
+\r
+Version 1.72 (Wed, May 25 2004)\r
+* Added Dutch, Swedish, Czech, Norwegian, and Turkish translations.\r
+* Received: Removed this method because spam filter programs like\r
+SpamAssassin reject this header.\r
+* Fixed error count bug.\r
+* SetLanguage default is now "language/".\r
+* Fixed magic_quotes_runtime bug.\r
+\r
+Version 1.71 (Tue, Jul 28 2003)\r
+* Made several speed enhancements\r
+* Added German and Italian translation files\r
+* Fixed HELO/AUTH bugs on keep-alive connects\r
+* Now provides an error message if language file does not load\r
+* Fixed attachment EOL bug\r
+* Updated some unclear documentation\r
+* Added additional tests and improved others\r
+\r
+Version 1.70 (Mon, Jun 20 2003)\r
+* Added SMTP keep-alive support\r
+* Added IsError method for error detection\r
+* Added error message translation support (SetLanguage)\r
+* Refactored many methods to increase library performance\r
+* Hello now sends the newer EHLO message before HELO as per RFC 2821\r
+* Removed the boundary class and replaced it with GetBoundary\r
+* Removed queue support methods\r
+* New $Hostname variable\r
+* New Message-ID header\r
+* Received header reformat\r
+* Helo variable default changed to $Hostname\r
+* Removed extra spaces in Content-Type definition (#667182)\r
+* Return-Path should be set to Sender when set\r
+* Adds Q or B encoding to headers when necessary\r
+* quoted-encoding should now encode NULs \000\r
+* Fixed encoding of body/AltBody (#553370)\r
+* Adds "To: undisclosed-recipients:;" when all recipients are hidden (BCC)\r
+* Multiple bug fixes\r
+\r
+Version 1.65 (Fri, Aug 09 2002)\r
+* Fixed non-visible attachment bug (#585097) for Outlook\r
+* SMTP connections are now closed after each transaction\r
+* Fixed SMTP::Expand return value\r
+* Converted SMTP class documentation to phpDocumentor format\r
+\r
+Version 1.62 (Wed, Jun 26 2002)\r
+* Fixed multi-attach bug\r
+* Set proper word wrapping\r
+* Reduced memory use with attachments\r
+* Added more debugging\r
+* Changed documentation to phpDocumentor format\r
+\r
+Version 1.60 (Sat, Mar 30 2002)\r
+* Sendmail pipe and address patch (Christian Holtje)\r
+* Added embedded image and read confirmation support (A. Ognio)\r
+* Added unit tests\r
+* Added SMTP timeout support (*nix only)\r
+* Added possibly temporary PluginDir variable for SMTP class\r
+* Added LE message line ending variable\r
+* Refactored boundary and attachment code\r
+* Eliminated SMTP class warnings\r
+* Added SendToQueue method for future queuing support\r
+\r
+Version 1.54 (Wed, Dec 19 2001)\r
+* Add some queuing support code\r
+* Fixed a pesky multi/alt bug\r
+* Messages are no longer forced to have "To" addresses\r
+\r
+Version 1.50 (Thu, Nov 08 2001)\r
+* Fix extra lines when not using SMTP mailer\r
+* Set WordWrap variable to int with a zero default\r
+\r
+Version 1.47 (Tue, Oct 16 2001)\r
+* Fixed Received header code format\r
+* Fixed AltBody order error\r
+* Fixed alternate port warning\r
+\r
+Version 1.45 (Tue, Sep 25 2001)\r
+* Added enhanced SMTP debug support\r
+* Added support for multiple ports on SMTP\r
+* Added Received header for tracing\r
+* Fixed AddStringAttachment encoding\r
+* Fixed possible header name quote bug\r
+* Fixed wordwrap() trim bug\r
+* Couple other small bug fixes\r
+\r
+Version 1.41 (Wed, Aug 22 2001)\r
+* Fixed AltBody bug w/o attachments\r
+* Fixed rfc_date() for certain mail servers\r
+\r
+Version 1.40 (Sun, Aug 12 2001)\r
+* Added multipart/alternative support (AltBody)\r
+* Documentation update\r
+* Fixed bug in Mercury MTA\r
+\r
+Version 1.29 (Fri, Aug 03 2001)\r
+* Added AddStringAttachment() method\r
+* Added SMTP authentication support\r
+\r
+Version 1.28 (Mon, Jul 30 2001)\r
+* Fixed a typo in SMTP class\r
+* Fixed header issue with Imail (win32) SMTP server\r
+* Made fopen() calls for attachments use "rb" to fix win32 error\r
+\r
+Version 1.25 (Mon, Jul 02 2001)\r
+* Added RFC 822 date fix (Patrice)\r
+* Added improved error handling by adding a $ErrorInfo variable\r
+* Removed MailerDebug variable (obsolete with new error handler)\r
+\r
+Version 1.20 (Mon, Jun 25 2001)\r
+* Added quoted-printable encoding (Patrice)\r
+* Set Version as public and removed PrintVersion()\r
+* Changed phpdoc to only display public variables and methods\r
+\r
+Version 1.19 (Thu, Jun 21 2001)\r
+* Fixed MS Mail header bug\r
+* Added fix for Bcc problem with mail(). *Does not work on Win32*\r
+ (See PHP bug report: http://www.php.net/bugs.php?id=11616)\r
+* mail() no longer passes a fifth parameter when not needed\r
+\r
+Version 1.15 (Fri, Jun 15 2001)\r
+[Note: these changes contributed by Patrice Fournier]\r
+* Changed all remaining \n to \r\n\r
+* Bcc: header no longer writen to message except\r
+when sent directly to sendmail\r
+* Added a small message to non-MIME compliant mail reader\r
+* Added Sender variable to change the Sender email\r
+used in -f for sendmail/mail and in 'MAIL FROM' for smtp mode\r
+* Changed boundary setting to a place it will be set only once\r
+* Removed transfer encoding for whole message when using multipart\r
+* Message body now uses Encoding in multipart messages\r
+* Can set encoding and type to attachments 7bit, 8bit\r
+and binary attachment are sent as is, base64 are encoded\r
+* Can set Encoding to base64 to send 8 bits body\r
+through 7 bits servers\r
+\r
+Version 1.10 (Tue, Jun 12 2001)\r
+* Fixed win32 mail header bug (printed out headers in message body)\r
+\r
+Version 1.09 (Fri, Jun 08 2001)\r
+* Changed date header to work with Netscape mail programs\r
+* Altered phpdoc documentation\r
+\r
+Version 1.08 (Tue, Jun 05 2001)\r
+* Added enhanced error-checking\r
+* Added phpdoc documentation to source\r
+\r
+Version 1.06 (Fri, Jun 01 2001)\r
+* Added optional name for file attachments\r
+\r
+Version 1.05 (Tue, May 29 2001)\r
+* Code cleanup\r
+* Eliminated sendmail header warning message\r
+* Fixed possible SMTP error\r
+\r
+Version 1.03 (Thu, May 24 2001)\r
+* Fixed problem where qmail sends out duplicate messages\r
+\r
+Version 1.02 (Wed, May 23 2001)\r
+* Added multiple recipient and attachment Clear* methods\r
+* Added Sendmail public variable\r
+* Fixed problem with loading SMTP library multiple times\r
+\r
+Version 0.98 (Tue, May 22 2001)\r
+* Fixed problem with redundant mail hosts sending out multiple messages\r
+* Added additional error handler code\r
+* Added AddCustomHeader() function\r
+* Added support for Microsoft mail client headers (affects priority)\r
+* Fixed small bug with Mailer variable\r
+* Added PrintVersion() function\r
+\r
+Version 0.92 (Tue, May 15 2001)\r
+* Changed file names to class.phpmailer.php and class.smtp.php to match\r
+ current PHP class trend.\r
+* Fixed problem where body not being printed when a message is attached\r
+* Several small bug fixes\r
+\r
+Version 0.90 (Tue, April 17 2001)\r
+* Intial public release\r
--- /dev/null
+/*******************************************************************\r
+* The http://phpmailer.codeworxtech.com/ website now carries a few *\r
+* advertisements through the Google Adsense network. Please visit *\r
+* the advertiser sites and help us offset some of our costs. *\r
+* Thanks .... *\r
+********************************************************************/\r
+\r
+PHPMailer\r
+Full Featured Email Transfer Class for PHP\r
+==========================================\r
+\r
+Version 2.1 (June 04 2008)\r
+\r
+With this release, we are announcing that the development of PHPMailer for PHP5\r
+will be our focus from this date on. We have implemented all the enhancements\r
+and fixes from the latest release of PHPMailer for PHP4.\r
+\r
+Far more important, though, is that this release of PHPMailer (v2.1) is\r
+fully tested with E_STRICT error checking enabled.\r
+\r
+** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.\r
+ IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE\r
+ APPRECIATED.\r
+\r
+We have now added S/MIME functionality (ability to digitally sign emails).\r
+BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.\r
+The "Signed Emails" functionality adds the Sign method to pass the private key\r
+filename and the password to read it, and then email will be sent with\r
+content-type multipart/signed and with the digital signature attached.\r
+\r
+A quick note on E_STRICT:\r
+\r
+- In about half the test environments the development version was subjected\r
+ to, an error was thrown for the date() functions (used at line 1565 and 1569).\r
+ This is NOT a PHPMailer error, it is the result of an incorrectly configured\r
+ PHP5 installation. The fix is to modify your 'php.ini' file and include the\r
+ date.timezone = America/New York\r
+ directive, (for your own server timezone)\r
+- If you do get this error, and are unable to access your php.ini file, there is\r
+ a workaround. In your PHP script, add\r
+ date_default_timezone_set('America/Toronto');\r
+\r
+ * do NOT try to use\r
+ $myVar = date_default_timezone_get();\r
+ as a test, it will throw an error.\r
+\r
+We have also included more example files to show the use of "sendmail", "mail()",\r
+"smtp", and "gmail".\r
+\r
+We are also looking for more programmers to join the volunteer development team.\r
+If you have an interest in this, please let us know.\r
+\r
+Enjoy!\r
+\r
+\r
+Version 2.1.0beta1 & beta2\r
+\r
+please note, this is BETA software\r
+** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS\r
+INTENDED STRICTLY FOR TESTING\r
+\r
+** NOTE:\r
+\r
+As of November 2007, PHPMailer has a new project team headed by industry\r
+veteran Andy Prevost (codeworxtech). The first release in more than two\r
+years will focus on fixes, adding ease-of-use enhancements, provide\r
+basic compatibility with PHP4 and PHP5 using PHP5 backwards compatibility\r
+features. A new release is planned before year-end 2007 that will provide\r
+full compatiblity with PHP4 and PHP5, as well as more bug fixes.\r
+\r
+We are looking for project developers to assist in restoring PHPMailer to\r
+its leadership position. Our goals are to simplify use of PHPMailer, provide\r
+good documentation and examples, and retain backward compatibility to level\r
+1.7.3 standards.\r
+\r
+If you are interested in helping out, visit http://sourceforge.net/phpmailer\r
+and indicate your interest.\r
+\r
+**\r
+\r
+http://phpmailer.sourceforge.net/\r
+\r
+This software is licenced under the LGPL. Please read LICENSE for information on the\r
+software availability and distribution.\r
+\r
+Class Features:\r
+- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs\r
+- Redundant SMTP servers\r
+- Multipart/alternative emails for mail clients that do not read HTML email\r
+- Support for 8bit, base64, binary, and quoted-printable encoding\r
+- Uses the same methods as the very popular AspEmail active server (COM) component\r
+- SMTP authentication\r
+- Native language support\r
+- Word wrap, and more!\r
+\r
+Why you might need it:\r
+\r
+Many PHP developers utilize email in their code. The only PHP function\r
+that supports this is the mail() function. However, it does not expose\r
+any of the popular features that many email clients use nowadays like\r
+HTML-based emails and attachments. There are two proprietary\r
+development tools out there that have all the functionality built into\r
+easy to use classes: AspEmail(tm) and AspMail. Both of these\r
+programs are COM components only available on Windows. They are also a\r
+little pricey for smaller projects.\r
+\r
+Since I do Linux development I\92ve missed these tools for my PHP coding.\r
+So I built a version myself that implements the same methods (object\r
+calls) that the Windows-based components do. It is open source and the\r
+LGPL license allows you to place the class in your proprietary PHP\r
+projects.\r
+\r
+\r
+Installation:\r
+\r
+Copy class.phpmailer.php into your php.ini include_path. If you are\r
+using the SMTP mailer then place class.smtp.php in your path as well.\r
+In the language directory you will find several files like\r
+phpmailer.lang-en.php. If you look right before the .php extension\r
+that there are two letters. These represent the language type of the\r
+translation file. For instance "en" is the English file and "br" is\r
+the Portuguese file. Chose the file that best fits with your language\r
+and place it in the PHP include path. If your language is English\r
+then you have nothing more to do. If it is a different language then\r
+you must point PHPMailer to the correct translation. To do this, call\r
+the PHPMailer SetLanguage method like so:\r
+\r
+// To load the Portuguese version\r
+$mail->SetLanguage("br", "/optional/path/to/language/directory/");\r
+\r
+That's it. You should now be ready to use PHPMailer!\r
+\r
+\r
+A Simple Example:\r
+\r
+<?php\r
+require("class.phpmailer.php");\r
+\r
+$mail = new PHPMailer();\r
+\r
+$mail->IsSMTP(); // set mailer to use SMTP\r
+$mail->Host = "smtp1.example.com;smtp2.example.com"; // specify main and backup server\r
+$mail->SMTPAuth = true; // turn on SMTP authentication\r
+$mail->Username = "jswan"; // SMTP username\r
+$mail->Password = "secret"; // SMTP password\r
+\r
+$mail->From = "from@example.com";\r
+$mail->FromName = "Mailer";\r
+$mail->AddAddress("josh@example.net", "Josh Adams");\r
+$mail->AddAddress("ellen@example.com"); // name is optional\r
+$mail->AddReplyTo("info@example.com", "Information");\r
+\r
+$mail->WordWrap = 50; // set word wrap to 50 characters\r
+$mail->AddAttachment("/var/tmp/file.tar.gz"); // add attachments\r
+$mail->AddAttachment("/tmp/image.jpg", "new.jpg"); // optional name\r
+$mail->IsHTML(true); // set email format to HTML\r
+\r
+$mail->Subject = "Here is the subject";\r
+$mail->Body = "This is the HTML message body <b>in bold!</b>";\r
+$mail->AltBody = "This is the body in plain text for non-HTML mail clients";\r
+\r
+if(!$mail->Send())\r
+{\r
+ echo "Message could not be sent. <p>";\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+ exit;\r
+}\r
+\r
+echo "Message has been sent";\r
+?>\r
+\r
+CHANGELOG\r
+\r
+See ChangeLog.txt\r
+\r
+Download: http://sourceforge.net/project/showfiles.php?group_id=26031\r
+\r
+Andy Prevost\r
--- /dev/null
+<html>\r
+<head>\r
+<title>Examples using phpmailer</title>\r
+</head>\r
+\r
+<body bgcolor="#FFFFFF">\r
+\r
+<h2>Examples using phpmailer</h2>\r
+\r
+<h3>1. Advanced Example</h3>\r
+<p>\r
+\r
+This demonstrates sending out multiple email messages with binary attachments\r
+from a MySQL database with multipart/alternative support.<p>\r
+<table cellpadding="4" border="1" width="80%">\r
+<tr>\r
+<td bgcolor="#CCCCCC">\r
+<pre>\r
+require("class.phpmailer.php");\r
+\r
+$mail = new phpmailer();\r
+\r
+$mail->From = "list@example.com";\r
+$mail->FromName = "List manager";\r
+$mail->Host = "smtp1.example.com;smtp2.example.com";\r
+$mail->Mailer = "smtp";\r
+\r
+@MYSQL_CONNECT("localhost","root","password");\r
+@mysql_select_db("my_company");\r
+$query = "SELECT full_name, email, photo FROM employee WHERE id=$id";\r
+$result = @MYSQL_QUERY($query);\r
+\r
+while ($row = mysql_fetch_array ($result))\r
+{\r
+ // HTML body\r
+ $body = "Hello <font size=\"4\">" . $row["full_name"] . "</font>, <p>";\r
+ $body .= "<i>Your</i> personal photograph to this message.<p>";\r
+ $body .= "Sincerely, <br>";\r
+ $body .= "phpmailer List manager";\r
+\r
+ // Plain text body (for mail clients that cannot read HTML)\r
+ $text_body = "Hello " . $row["full_name"] . ", \n\n";\r
+ $text_body .= "Your personal photograph to this message.\n\n";\r
+ $text_body .= "Sincerely, \n";\r
+ $text_body .= "phpmailer List manager";\r
+\r
+ $mail->Body = $body;\r
+ $mail->AltBody = $text_body;\r
+ $mail->AddAddress($row["email"], $row["full_name"]);\r
+ $mail->AddStringAttachment($row["photo"], "YourPhoto.jpg");\r
+\r
+ if(!$mail->Send())\r
+ echo "There has been a mail error sending to " . $row["email"] . "<br>";\r
+\r
+ // Clear all addresses and attachments for next loop\r
+ $mail->ClearAddresses();\r
+ $mail->ClearAttachments();\r
+}\r
+</pre>\r
+</td>\r
+</tr>\r
+</table>\r
+<p>\r
+\r
+<h3>2. Extending phpmailer</h3>\r
+<p>\r
+\r
+Extending classes with inheritance is one of the most\r
+powerful features of object-oriented\r
+programming. It allows you to make changes to the\r
+original class for your\r
+own personal use without hacking the original\r
+classes. Plus, it is very\r
+easy to do. I've provided an example:\r
+\r
+<p>\r
+Here's a class that extends the phpmailer class and sets the defaults\r
+for the particular site:<br>\r
+PHP include file: <b>mail.inc.php</b>\r
+<p>\r
+\r
+<table cellpadding="4" border="1" width="80%">\r
+<tr>\r
+<td bgcolor="#CCCCCC">\r
+<pre>\r
+require("class.phpmailer.php");\r
+\r
+class my_phpmailer extends phpmailer {\r
+ // Set default variables for all new objects\r
+ var $From = "from@example.com";\r
+ var $FromName = "Mailer";\r
+ var $Host = "smtp1.example.com;smtp2.example.com";\r
+ var $Mailer = "smtp"; // Alternative to IsSMTP()\r
+ var $WordWrap = 75;\r
+\r
+ // Replace the default error_handler\r
+ function error_handler($msg) {\r
+ print("My Site Error");\r
+ print("Description:");\r
+ printf("%s", $msg);\r
+ exit;\r
+ }\r
+\r
+ // Create an additional function\r
+ function do_something($something) {\r
+ // Place your new code here\r
+ }\r
+}\r
+</td>\r
+</tr>\r
+</table>\r
+<br>\r
+\r
+Now here's a normal PHP page in the site, which will have all the defaults set\r
+above:<br>\r
+Normal PHP file: <b>mail_test.php</b>\r
+<p>\r
+\r
+<table cellpadding="4" border="1" width="80%">\r
+<tr>\r
+<td bgcolor="#CCCCCC">\r
+<pre>\r
+require("mail.inc.php");\r
+\r
+// Instantiate your new class\r
+$mail = new my_phpmailer;\r
+\r
+// Now you only need to add the necessary stuff\r
+$mail->AddAddress("josh@example.com", "Josh Adams");\r
+$mail->Subject = "Here is the subject";\r
+$mail->Body = "This is the message body";\r
+$mail->AddAttachment("c:/temp/11-10-00.zip", "new_name.zip"); // optional name\r
+\r
+if(!$mail->Send())\r
+{\r
+ echo "There was an error sending the message";\r
+ exit;\r
+}\r
+\r
+echo "Message was sent successfully";\r
+</pre>\r
+</td>\r
+</tr>\r
+</table>\r
+</p>\r
+\r
+</body>\r
+</html>\r
--- /dev/null
+<html>\r
+<head>\r
+<title>PHPMailer FAQ</title>\r
+<style>\r
+body, p {\r
+ font-family: Arial, Helvetica, sans-serif;\r
+ font-size: 12px;\r
+}\r
+div.width {\r
+ width: 500px;\r
+ text-align: left;\r
+}\r
+</style>\r
+</head>\r
+<body bgcolor="#FFFFFF">\r
+<center>\r
+<div class="width">\r
+<h2>PHPMailer FAQ</h2>\r
+<ul>\r
+\r
+ <li><b style="background-color: #FFFF00">Q:</b> <b>I'm using the SMTP mailer and I keep on getting a timeout message\r
+ well before the X seconds I set it for. What gives?</b><br />\r
+ <b style="background-color: #FFFF00">A:</b> PHP versions 4.0.4pl1 and earlier have a bug in which sockets timeout\r
+ early. You can fix this by re-compiling PHP 4.0.4pl1 with this fix:\r
+ <a href="timeoutfix.diff">timeoutfix.diff</a>. Otherwise you can wait for the new PHP release.<br /><br /></li>\r
+\r
+ <li><b style="background-color: #FFFF00">Q:</b> <b>I am concerned that using include files will take up too much\r
+ processing time on my computer. How can I make it run faster?</b><br />\r
+ <b style="background-color: #FFFF00">A:</b> PHP by itself is very fast. Much faster than ASP or JSP running on\r
+ the same type of server. This is because it has very little overhead compared\r
+ to its competitors and it pre-compiles all of\r
+ its code before it runs each script (in PHP4). However, all of\r
+ this compiling and re-compiling can take up a lot of valuable\r
+ computer resources. However, there are programs out there that compile\r
+ PHP code and store it in memory (or on mmaped files) to reduce the\r
+ processing immensely. Two of these: <a href="http://apc.communityconnect.com">APC\r
+ (Alternative PHP Cache)</a> and <a href="http://bwcache.bware.it/index.htm">Afterburner</a>\r
+ (<a href="http://www.mm4.de/php4win/mod_php4_win32/">Win32 download</a>)\r
+ are excellent free tools that do just this. If you have the money\r
+ you might also try <a href="http://www.zend.com">Zend Cache</a>, it is\r
+ even faster than the open source varieties. All of these tools make your\r
+ scripts run faster while also reducing the load on your server. I have tried\r
+ them myself and they are quite stable too.<br /><br /></li>\r
+\r
+ <li><b style="background-color: #FFFF00">Q:</b> <b>What mailer gives me the best performance?</b><br />\r
+ <b style="background-color: #FFFF00">A:</b> On a single machine the <b>sendmail (or Qmail)</b> is fastest overall.\r
+ Next fastest is mail() to give you the best performance. Both do not have the overhead of SMTP.\r
+ If you have you have your mail server on a another machine then\r
+ SMTP is your only option, but you do get the benefit of redundant mail servers.<br />\r
+ If you are running a mailing list with thousands of names, the fastest mailers in order are: SMTP, sendmail (or Qmail), mail().<br /><br /></li>\r
+\r
+ <li><b style="background-color: #FFFF00">Q:</b> <b>When I try to attach a file with on my server I get a\r
+ "Could not find {file} on filesystem error". Why is this?</b><br />\r
+ <b style="background-color: #FFFF00">A:</b> If you are using a Unix machine this is probably because the user\r
+ running your web server does not have read access to the directory in question. If you are using Windows,\r
+ then the problem probably is that you have used single backslashes to denote directories (\).\r
+ A single backslash has a special meaning to PHP so these are not\r
+ valid. Instead use double backslashes ("\\") or a single forward\r
+ slash ("/").<br /><br /></li>\r
+\r
+</ul>\r
+\r
+</div>\r
+</center>\r
+\r
+</body>\r
+</html>\r
--- /dev/null
+This is built for PHP Mailer 1.72 and was not tested with any previous version. It was developed under PHP 4.3.11 (E_ALL). It works under PHP 5 and 5.1 with E_ALL, but not in Strict mode due to var deprecation (but then neither does PHP Mailer either!). It follows the RFC 1939 standard explicitly and is fully commented.\r
+\r
+With that noted, here is how to implement it:\r
+Install the class file\r
+\r
+I didn't want to modify the PHP Mailer classes at all, so you will have to include/require this class along with the base one. It can sit quite happily in the phpmailer-1.72 directory:\r
+[geshi lang=php] require 'phpmailer-1.72/class.phpmailer.php'; require 'phpmailer-1.72/class.pop3.php'; [/geshi]\r
+When you need it, create your POP3 object\r
+\r
+Right before I invoke PHP Mailer I activate the POP3 authorisation. POP3 before SMTP is a process whereby you login to your web hosts POP3 mail server BEFORE sending out any emails via SMTP. The POP3 logon 'verifies' your ability to send email by SMTP, which typically otherwise blocks you. On my web host (Pair Networks) a single POP3 logon is enough to 'verify' you for 90 minutes. Here is some sample PHP code that activates the POP3 logon and then sends an email via PHP Mailer:\r
+[geshi lang=php] Authorise('pop3.example.com', 110, 30, 'mailer', 'password', 1); $mail = new PHPMailer(); $mail->SMTPDebug = 2; $mail->IsSMTP(); $mail->IsHTML(false); $mail->Host = 'relay.example.com'; $mail->From = 'mailer@example.com'; $mail->FromName = 'Example Mailer'; $mail->Subject = 'My subject'; $mail->Body = 'Hello world'; $mail->AddAddress('rich@corephp.co.uk', 'Richard Davey'); if (!$mail->Send()) { echo $mail->ErrorInfo; } ?> [/geshi]\r
+\r
+The PHP Mailer parts of this code should be obvious to anyone who has used PHP Mailer before. One thing to note - you almost certainly will not need to use SMTP Authentication *and* POP3 before SMTP together. The Authorisation method is a proxy method to all of the others within that class. There are Connect, Logon and Disconnect methods available, but I wrapped them in the single Authorisation one to make things easier.\r
+The Parameters\r
+\r
+The Authorise parameters are as follows:\r
+[geshi lang=php]$pop->Authorise('pop3.example.com', 110, 30, 'mailer', 'password', 1);[/geshi]\r
+\r
+ 1. pop3.example.com - The POP3 Mail Server Name (hostname or IP address)\r
+ 2. 110 - The POP3 Port on which to connect (default is usually 110, but check with your host)\r
+ 3. 30 - A connection time-out value (in seconds)\r
+ 4. mailer - The POP3 Username required to logon\r
+ 5. password - The POP3 Password required to logon\r
+ 6. 1 - The class debug level (0 = off, 1+ = debug output is echoed to the browser)\r
+\r
+Final Comments + the Download\r
+\r
+1) This class does not support APOP connections. This is only because I did not have an APOP server to test with, but if you'd like to see that added just contact me.\r
+\r
+2) Opening and closing lots of POP3 connections can be quite a resource/network drain. If you need to send a whole batch of emails then just perform the authentication once at the start, and then loop through your mail sending script. Providing this process doesn't take longer than the verification period lasts on your POP3 server, you should be fine. With my host that period is 90 minutes, i.e. plenty of time.\r
+\r
+3) If you have heavy requirements for this script (i.e. send a LOT of email on a frequent basis) then I would advise seeking out an alternative sending method (direct SMTP ideally). If this isn't possible then you could modify this class so the 'last authorised' date is recorded somewhere (MySQL, Flat file, etc) meaning you only open a new connection if the old one has expired, saving you precious overhead.\r
+\r
+4) There are lots of other POP3 classes for PHP available. However most of them implement the full POP3 command set, where-as this one is purely for authentication, and much lighter as a result. However using any of the other POP3 classes to just logon to your server would have the same net result. At the end of the day, use whatever method you feel most comfortable with.\r
+Download\r
+\r
+Here is the full class file plus my test script: POP_before_SMTP_PHPMailer.zip (4 KB) - Please note that it does not include PHPMailer itself.\r
+\r
+My thanks to Chris Ryan for the inspiration (even if indirectly, via his SMTP class)\r
--- /dev/null
+<?php\r
+\r
+// example on using PHPMailer with GMAIL\r
+\r
+include("class.phpmailer.php");\r
+include("class.smtp.php"); // note, this is optional - gets called from main class if not already loaded\r
+\r
+$mail = new PHPMailer();\r
+\r
+$body = $mail->getFile('contents.html');\r
+$body = eregi_replace("[\]",'',$body);\r
+\r
+$mail->IsSMTP();\r
+$mail->SMTPAuth = true; // enable SMTP authentication\r
+$mail->SMTPSecure = "ssl"; // sets the prefix to the servier\r
+$mail->Host = "smtp.gmail.com"; // sets GMAIL as the SMTP server\r
+$mail->Port = 465; // set the SMTP port\r
+\r
+$mail->Username = "yourname@gmail.com"; // GMAIL username\r
+$mail->Password = "password"; // GMAIL password\r
+\r
+$mail->From = "replyto@yourdomain.com";\r
+$mail->FromName = "Webmaster";\r
+$mail->Subject = "This is the subject";\r
+$mail->AltBody = "This is the body when user views in plain text format"; //Text Body\r
+$mail->WordWrap = 50; // set word wrap\r
+\r
+$mail->MsgHTML($body);\r
+\r
+$mail->AddReplyTo("replyto@yourdomain.com","Webmaster");\r
+\r
+$mail->AddAttachment("/path/to/file.zip"); // attachment\r
+$mail->AddAttachment("/path/to/image.jpg", "new.jpg"); // attachment\r
+\r
+$mail->AddAddress("username@domain.com","First Last");\r
+\r
+$mail->IsHTML(true); // send as HTML\r
+\r
+if(!$mail->Send()) {\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+} else {\r
+ echo "Message has been sent";\r
+}\r
+\r
+?>\r
--- /dev/null
+<body background="images/bkgrnd.gif" style="margin: 0px;">\r
+<div style="width: 640px; font-family: Arial, Helvetica, sans-serif; font-size: 11px;">\r
+<div align="center"><img src="images/phpmailer.gif" style="height: 90px; width: 340px"></div><br>\r
+<br>\r
+ This is a test of PHPMailer v2.0.0 rc1.<br>\r
+<br>\r
+This particular example uses <strong>HTML</strong>, with a <div> tag and inline<br>\r
+styles.<br>\r
+<br>\r
+Also note the use of the PHPMailer at the top with no specific code to handle\r
+including it in the body of the email.</div>\r
+</body>\r
--- /dev/null
+<p>The example file "test_mail.php" contents include:</p>\r
+<div style="width: 600px; background-color: #CCCCCC;">\r
+<code>\r
+<?php<br>\r
+<br>\r
+include_once('../class.phpmailer.php');<br>\r
+<br>\r
+$mail = new PHPMailer();<br>\r
+<br>\r
+$body = $mail->getFile('contents.html');<br>\r
+<br>\r
+$body = eregi_replace("[\]",'',$body);<br>\r
+$subject = eregi_replace("[\]",'',$subject);<br>\r
+<br>\r
+$mail->From = "name@yourdomain.com";<br>\r
+$mail->FromName = "First Last";<br>\r
+<br>\r
+$mail->Subject = "PHPMailer Test Subject";<br>\r
+<br>\r
+$mail->AltBody = "To view the message, please use an HTML compatible email viewer!"; // optional, comment out and test<br>\r
+<br>\r
+$mail->MsgHTML($body);<br>\r
+<br>\r
+$mail->AddAddress("whoto@otherdomain.com", "John Doe");<br>\r
+<br>\r
+if(!$mail->Send()) {<br>\r
+ echo 'Failed to send mail';<br>\r
+} else {<br>\r
+ echo 'Mail sent';<br>\r
+}<br>\r
+<br>\r
+?>\r
+</code>\r
+</div>\r
+<br>\r
+Although you could use full compabitility with PHPMailer 1.7.3, this example\r
+shows how to use the new features. If you view 'contents.html', you will note\r
+that there is a background image used in the <body tag as well as an image used\r
+with a regular <img tag. Here's what the HTML file looks like:<br>\r
+<br>\r
+<div style="width: 600px; background-color: #CCCCCC;">\r
+<code>\r
+<body background="images/bkgrnd.gif" style="margin: 0px;"><br>\r
+<div style="width: 640px; font-family: Arial, Helvetica, sans-serif; font-size: 11px;"><br>\r
+<div align="center"><img src="images/phpmailer.gif" style="height: 90px; width: 340px"></div><br><br>\r
+<br><br>\r
+ This is a test of PHPMailer v2.0.0 rc1.<br><br>\r
+<br><br>\r
+This particular example uses <strong>HTML</strong>, with a <div> tag and inline<br><br>\r
+styles.<br><br>\r
+<br><br>\r
+Also note the use of the PHPMailer at the top with no specific code to handle<br>\r
+including it in the body of the email.</div><br>\r
+</body><br>\r
+</code>\r
+</div>\r
+<br>\r
+A few things to notice in the PHP script that generates the email:\r
+<ul>\r
+ <li>the use of $mail->AltBody is completely optional. If not used, PHPMailer\r
+ will use the HTML text with htmlentities().</li>\r
+ <li>the background= and <img src= images were processed without any directives\r
+ or methods from the PHP script</li>\r
+ <li>there is no specific code to define the image type ... that is handled\r
+ automatically by PHPMailer when it parses the images</li>\r
+ <li>we are using a new class method '$mail->MsgHTML($body)' ... that is what will handle the parsing of the images and creating the AltBody text</li>\r
+</ul>\r
+<p>Of course, you can still use PHPMailer the same way you have in the past.\r
+That provides full compatibility with all existing scripts, while new scripts\r
+can take advantage of the new features.</p>\r
+<p>Modify test_mail.php now with your own email address and try it out.</p>\r
+To see what the email SHOULD look like in your HTML compatible email viewer: <a href="contents.html">click here</a><br>\r
+\r
--- /dev/null
+<html>\r
+<head>\r
+<title>POP before SMTP Test</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<pre>\r
+<?php\r
+ require 'class.phpmailer.php';\r
+ require 'class.pop3.php';\r
+\r
+ $pop = new POP3();\r
+ $pop->Authorise('pop3.example.com', 110, 30, 'mailer', 'password', 1);\r
+\r
+ $mail = new PHPMailer();\r
+\r
+ $mail->IsSMTP();\r
+ $mail->SMTPDebug = 2;\r
+ $mail->IsHTML(false);\r
+\r
+ $mail->Host = 'relay.example.com';\r
+\r
+ $mail->From = 'mailer@example.com';\r
+ $mail->FromName = 'Example Mailer';\r
+\r
+ $mail->Subject = 'My subject';\r
+ $mail->Body = 'Hello world';\r
+ $mail->AddAddress('name@anydomain.com', 'First Last');\r
+\r
+ if (!$mail->Send())\r
+ {\r
+ echo $mail->ErrorInfo;\r
+ }\r
+?>\r
+</pre>\r
+\r
+</body>\r
+</html>\r
--- /dev/null
+<?php\r
+\r
+//error_reporting(E_ALL);\r
+error_reporting(E_STRICT);\r
+\r
+date_default_timezone_set('America/Toronto');\r
+\r
+include("class.phpmailer.php");\r
+//include("class.smtp.php"); // optional, gets called from within class.phpmailer.php if not already loaded\r
+\r
+$mail = new PHPMailer();\r
+\r
+$body = $mail->getFile('contents.html');\r
+$body = eregi_replace("[\]",'',$body);\r
+\r
+$mail->IsSMTP();\r
+$mail->SMTPAuth = true; // enable SMTP authentication\r
+$mail->SMTPSecure = "ssl"; // sets the prefix to the servier\r
+$mail->Host = "smtp.gmail.com"; // sets GMAIL as the SMTP server\r
+$mail->Port = 465; // set the SMTP port for the GMAIL server\r
+\r
+$mail->Username = "yourusername@gmail.com"; // GMAIL username\r
+$mail->Password = "yourpassword"; // GMAIL password\r
+\r
+$mail->AddReplyTo("yourusername@gmail.com","First Last");\r
+\r
+$mail->From = "name@yourdomain.com";\r
+$mail->FromName = "First Last";\r
+\r
+$mail->Subject = "PHPMailer Test Subject via gmail";\r
+\r
+//$mail->Body = "Hi,<br>This is the HTML BODY<br>"; //HTML Body\r
+$mail->AltBody = "To view the message, please use an HTML compatible email viewer!"; // optional, comment out and test\r
+$mail->WordWrap = 50; // set word wrap\r
+\r
+$mail->MsgHTML($body);\r
+\r
+$mail->AddAddress("whoto@otherdomain.com", "John Doe");\r
+\r
+$mail->AddAttachment("images/phpmailer.gif"); // attachment\r
+\r
+$mail->IsHTML(true); // send as HTML\r
+\r
+if(!$mail->Send()) {\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+} else {\r
+ echo "Message sent!";\r
+}\r
+\r
+?>\r
--- /dev/null
+<?php\r
+\r
+include_once('../class.phpmailer.php');\r
+\r
+$mail = new PHPMailer(); // defaults to using php "mail()"\r
+\r
+$body = $mail->getFile('contents.html');\r
+$body = eregi_replace("[\]",'',$body);\r
+\r
+$mail->From = "name@yourdomain.com";\r
+$mail->FromName = "First Last";\r
+\r
+$mail->Subject = "PHPMailer Test Subject via mail()";\r
+\r
+$mail->AltBody = "To view the message, please use an HTML compatible email viewer!"; // optional, comment out and test\r
+\r
+$mail->MsgHTML($body);\r
+\r
+$mail->AddAddress("whoto@otherdomain.com", "John Doe");\r
+\r
+$mail->AddAttachment("images/phpmailer.gif"); // attachment\r
+\r
+if(!$mail->Send()) {\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+} else {\r
+ echo "Message sent!";\r
+}\r
+\r
+?>\r
--- /dev/null
+<?php\r
+\r
+//error_reporting(E_ALL);\r
+error_reporting(E_STRICT);\r
+\r
+\r
+date_default_timezone_set('America/Toronto');\r
+//date_default_timezone_set(date_default_timezone_get());\r
+\r
+include_once('class.phpmailer.php');\r
+\r
+$mail = new PHPMailer();\r
+$body = $mail->getFile('contents.html');\r
+$body = eregi_replace("[\]",'',$body);\r
+\r
+$mail->IsSendmail(); // telling the class to use SendMail transport\r
+\r
+$mail->From = "name@yourdomain.com";\r
+$mail->FromName = "First Last";\r
+\r
+$mail->Subject = "PHPMailer Test Subject via smtp";\r
+\r
+$mail->AltBody = "To view the message, please use an HTML compatible email viewer!"; // optional, comment out and test\r
+\r
+$mail->MsgHTML($body);\r
+\r
+$mail->AddAddress("whoto@otherdomain.com", "John Doe");\r
+\r
+$mail->AddAttachment("images/phpmailer.gif"); // attachment\r
+\r
+if(!$mail->Send()) {\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+} else {\r
+ echo "Message sent!";\r
+}\r
+\r
+?>\r
--- /dev/null
+<?php\r
+\r
+//error_reporting(E_ALL);\r
+error_reporting(E_STRICT);\r
+\r
+date_default_timezone_set('America/Toronto');\r
+//date_default_timezone_set(date_default_timezone_get());\r
+\r
+include_once('class.phpmailer.php');\r
+//include("class.smtp.php"); // optional, gets called from within class.phpmailer.php if not already loaded\r
+\r
+$mail = new PHPMailer();\r
+\r
+$body = $mail->getFile('contents.html');\r
+$body = eregi_replace("[\]",'',$body);\r
+\r
+$mail->IsSMTP(); // telling the class to use SMTP\r
+$mail->Host = "mail.worxteam.com"; // SMTP server\r
+\r
+$mail->From = "name@yourdomain.com";\r
+$mail->FromName = "First Last";\r
+\r
+$mail->Subject = "PHPMailer Test Subject via smtp";\r
+\r
+$mail->AltBody = "To view the message, please use an HTML compatible email viewer!"; // optional, comment out and test\r
+\r
+$mail->MsgHTML($body);\r
+\r
+$mail->AddAddress("whoto@otherdomain.com", "John Doe");\r
+\r
+$mail->AddAttachment("images/phpmailer.gif"); // attachment\r
+\r
+if(!$mail->Send()) {\r
+ echo "Mailer Error: " . $mail->ErrorInfo;\r
+} else {\r
+ echo "Message sent!";\r
+}\r
+\r
+?>\r
--- /dev/null
+Deny from all
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class PHPMailer</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class PHPMailer</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">PHPMailer - PHP email transport class</p>
+ <ul class="tags">
+ <li><span class="field">copyright:</span> <p>2001 - 2003 Brent R. Matzelle</p></li>
+ <li><span class="field">author:</span> <p>Brent R. Matzelle</p></li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_class_phpmailer_php.html">Program_Root/class.phpmailer.php</a> (line <span class="field">20</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$AltBody" title="details" class="var-name">$AltBody</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Body" title="details" class="var-name">$Body</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$CharSet" title="details" class="var-name">$CharSet</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$ConfirmReadingTo" title="details" class="var-name">$ConfirmReadingTo</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$ContentType" title="details" class="var-name">$ContentType</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Encoding" title="details" class="var-name">$Encoding</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$ErrorInfo" title="details" class="var-name">$ErrorInfo</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$From" title="details" class="var-name">$From</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$FromName" title="details" class="var-name">$FromName</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Helo" title="details" class="var-name">$Helo</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Host" title="details" class="var-name">$Host</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Hostname" title="details" class="var-name">$Hostname</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Mailer" title="details" class="var-name">$Mailer</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Password" title="details" class="var-name">$Password</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$PluginDir" title="details" class="var-name">$PluginDir</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">int</span>
+ <a href="#$Port" title="details" class="var-name">$Port</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">int</span>
+ <a href="#$Priority" title="details" class="var-name">$Priority</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Sender" title="details" class="var-name">$Sender</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Sendmail" title="details" class="var-name">$Sendmail</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">bool</span>
+ <a href="#$SMTPAuth" title="details" class="var-name">$SMTPAuth</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">bool</span>
+ <a href="#$SMTPDebug" title="details" class="var-name">$SMTPDebug</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">bool</span>
+ <a href="#$SMTPKeepAlive" title="details" class="var-name">$SMTPKeepAlive</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Subject" title="details" class="var-name">$Subject</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">int</span>
+ <a href="#$Timeout" title="details" class="var-name">$Timeout</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Username" title="details" class="var-name">$Username</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$Version" title="details" class="var-name">$Version</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">int</span>
+ <a href="#$WordWrap" title="details" class="var-name">$WordWrap</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+
+ |
+ <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddAddress" title="details" class="method-name">AddAddress</a>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#AddAttachment" title="details" class="method-name">AddAttachment</a>
+ (<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddBCC" title="details" class="method-name">AddBCC</a>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddCC" title="details" class="method-name">AddCC</a>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddCustomHeader" title="details" class="method-name">AddCustomHeader</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$custom_header</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#AddEmbeddedImage" title="details" class="method-name">AddEmbeddedImage</a>
+ (<span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">string</span> <span class="var-name">$cid</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddReplyTo" title="details" class="method-name">AddReplyTo</a>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#AddStringAttachment" title="details" class="method-name">AddStringAttachment</a>
+ (<span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearAddresses" title="details" class="method-name">ClearAddresses</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearAllRecipients" title="details" class="method-name">ClearAllRecipients</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearAttachments" title="details" class="method-name">ClearAttachments</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearBCCs" title="details" class="method-name">ClearBCCs</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearCCs" title="details" class="method-name">ClearCCs</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearCustomHeaders" title="details" class="method-name">ClearCustomHeaders</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#ClearReplyTos" title="details" class="method-name">ClearReplyTos</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#IsError" title="details" class="method-name">IsError</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#IsHTML" title="details" class="method-name">IsHTML</a>
+ (<span class="var-type">bool</span> <span class="var-name">$bool</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#IsMail" title="details" class="method-name">IsMail</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#IsQmail" title="details" class="method-name">IsQmail</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#IsSendmail" title="details" class="method-name">IsSendmail</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#IsSMTP" title="details" class="method-name">IsSMTP</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Send" title="details" class="method-name">Send</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#SetLanguage" title="details" class="method-name">SetLanguage</a>
+ (<span class="var-type">string</span> <span class="var-name">$lang_type</span>, [<span class="var-type">string</span> <span class="var-name">$lang_path</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#SmtpClose" title="details" class="method-name">SmtpClose</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$AltBody" id="$AltBody"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$AltBody</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">96</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+
+
+
+
+
+</div>
+<a name="var$Body" id="$Body"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Body</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">87</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the Body of the message. This can be either an HTML or text body.</p>
+<p class="description"><p>If HTML then run IsHTML(true).</p></p>
+
+
+
+
+
+</div>
+<a name="var$CharSet" id="$CharSet"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$CharSet</span>
+ = <span class="var-default"> "iso-8859-1"</span> (line <span class="line-number">36</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the CharSet of the message.</p>
+
+
+
+
+
+</div>
+<a name="var$ConfirmReadingTo" id="$ConfirmReadingTo"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$ConfirmReadingTo</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">134</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the email address that a reading confirmation will be sent.</p>
+
+
+
+
+
+</div>
+<a name="var$ContentType" id="$ContentType"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$ContentType</span>
+ = <span class="var-default"> "text/plain"</span> (line <span class="line-number">42</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the Content-type of the message.</p>
+
+
+
+
+
+</div>
+<a name="var$Encoding" id="$Encoding"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Encoding</span>
+ = <span class="var-default"> "8bit"</span> (line <span class="line-number">49</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</p>
+
+
+
+
+
+</div>
+<a name="var$ErrorInfo" id="$ErrorInfo"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$ErrorInfo</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">55</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Holds the most recent mailer error message.</p>
+
+
+
+
+
+</div>
+<a name="var$From" id="$From"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$From</span>
+ = <span class="var-default"> "root@localhost"</span> (line <span class="line-number">61</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the From email address for the message.</p>
+
+
+
+
+
+</div>
+<a name="var$FromName" id="$FromName"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$FromName</span>
+ = <span class="var-default"> "Root User"</span> (line <span class="line-number">67</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the From name of the message.</p>
+
+
+
+
+
+</div>
+<a name="var$Helo" id="$Helo"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Helo</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">169</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the SMTP HELO of the message (Default is $Hostname).</p>
+
+
+
+
+
+</div>
+<a name="var$Host" id="$Host"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Host</span>
+ = <span class="var-default"> "localhost"</span> (line <span class="line-number">157</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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").</p>
+<p class="description"><p>Hosts will be tried in order.</p></p>
+
+
+
+
+
+</div>
+<a name="var$Hostname" id="$Hostname"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Hostname</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">142</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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'.</p>
+
+
+
+
+
+</div>
+<a name="var$Mailer" id="$Mailer"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Mailer</span>
+ = <span class="var-default"> "mail"</span> (line <span class="line-number">109</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Method to send mail: ("mail", "sendmail", or "smtp").</p>
+
+
+
+
+
+</div>
+<a name="var$Password" id="$Password"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Password</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">187</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets SMTP password.</p>
+
+
+
+
+
+</div>
+<a name="var$PluginDir" id="$PluginDir"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$PluginDir</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">122</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</p>
+
+
+
+
+
+</div>
+<a name="var$Port" id="$Port"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">int</span>
+ <span class="var-name">$Port</span>
+ = <span class="var-default"> 25</span> (line <span class="line-number">163</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the default SMTP server port.</p>
+
+
+
+
+
+</div>
+<a name="var$Priority" id="$Priority"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">int</span>
+ <span class="var-name">$Priority</span>
+ = <span class="var-default"> 3</span> (line <span class="line-number">30</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Email priority (1 = High, 3 = Normal, 5 = low).</p>
+
+
+
+
+
+</div>
+<a name="var$Sender" id="$Sender"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Sender</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">74</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+
+
+
+
+
+</div>
+<a name="var$Sendmail" id="$Sendmail"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Sendmail</span>
+ = <span class="var-default"> "/usr/sbin/sendmail"</span> (line <span class="line-number">115</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the path of the sendmail program.</p>
+
+
+
+
+
+</div>
+<a name="var$SMTPAuth" id="$SMTPAuth"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">bool</span>
+ <span class="var-name">$SMTPAuth</span>
+ = <span class="var-default"> false</span> (line <span class="line-number">175</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets SMTP authentication. Utilizes the Username and Password variables.</p>
+
+
+
+
+
+</div>
+<a name="var$SMTPDebug" id="$SMTPDebug"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">bool</span>
+ <span class="var-name">$SMTPDebug</span>
+ = <span class="var-default"> false</span> (line <span class="line-number">200</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets SMTP class debugging on or off.</p>
+
+
+
+
+
+</div>
+<a name="var$SMTPKeepAlive" id="$SMTPKeepAlive"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">bool</span>
+ <span class="var-name">$SMTPKeepAlive</span>
+ = <span class="var-default"> false</span> (line <span class="line-number">208</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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().</p>
+
+
+
+
+
+</div>
+<a name="var$Subject" id="$Subject"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Subject</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">80</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the Subject of the message.</p>
+
+
+
+
+
+</div>
+<a name="var$Timeout" id="$Timeout"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">int</span>
+ <span class="var-name">$Timeout</span>
+ = <span class="var-default"> 10</span> (line <span class="line-number">194</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</p>
+
+
+
+
+
+</div>
+<a name="var$Username" id="$Username"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Username</span>
+ = <span class="var-default"> ""</span> (line <span class="line-number">181</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets SMTP username.</p>
+
+
+
+
+
+</div>
+<a name="var$Version" id="$Version"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$Version</span>
+ = <span class="var-default"> "1.71"</span> (line <span class="line-number">128</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Holds PHPMailer version.</p>
+
+
+
+
+
+</div>
+<a name="var$WordWrap" id="$WordWrap"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">int</span>
+ <span class="var-name">$WordWrap</span>
+ = <span class="var-default"> 0</span> (line <span class="line-number">103</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets word wrapping on the body of the message to a given number of characters.</p>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+<a name="methodAddAddress" id="AddAddress"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">AddAddress</span> (line <span class="line-number">287</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a "To" address.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddAddress
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$address</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddAttachment" id="AddAttachment"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">AddAttachment</span> (line <span class="line-number">1000</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds an attachment from a path on the filesystem.</p>
+<p class="description"><p>Returns false if the file could not be found or accessed.</p></p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ AddAttachment
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$path</span><span class="var-description">: <p>Path to the attachment.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: <p>Overrides the attachment name.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddBCC" id="AddBCC"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">AddBCC</span> (line <span class="line-number">315</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddBCC
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$address</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddCC" id="AddCC"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">AddCC</span> (line <span class="line-number">301</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddCC
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$address</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddCustomHeader" id="AddCustomHeader"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">AddCustomHeader</span> (line <span class="line-number">1525</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a custom header.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddCustomHeader
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$custom_header</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodAddEmbeddedImage" id="AddEmbeddedImage"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">AddEmbeddedImage</span> (line <span class="line-number">1275</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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".</p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ AddEmbeddedImage
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">string</span> <span class="var-name">$cid</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$path</span><span class="var-description">: <p>Path to the attachment.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$cid</span><span class="var-description">: <p>Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: <p>Overrides the attachment name.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddReplyTo" id="AddReplyTo"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">AddReplyTo</span> (line <span class="line-number">327</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a "Reply-to" address.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddReplyTo
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$address</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodAddStringAttachment" id="AddStringAttachment"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">AddStringAttachment</span> (line <span class="line-number">1248</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Adds a string or binary attachment (non-filesystem) to the list.</p>
+<p class="description"><p>This method can be used to attach ascii or binary data, such as a BLOB record from a database.</p></p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ AddStringAttachment
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$string</span><span class="var-description">: <p>String attachment data.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$filename</span><span class="var-description">: <p>Name of the attachment.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodClearAddresses" id="ClearAddresses"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearAddresses</span> (line <span class="line-number">1329</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all recipients assigned in the TO array. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearAddresses
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearAllRecipients" id="ClearAllRecipients"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearAllRecipients</span> (line <span class="line-number">1362</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearAllRecipients
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearAttachments" id="ClearAttachments"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearAttachments</span> (line <span class="line-number">1373</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearAttachments
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearBCCs" id="ClearBCCs"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearBCCs</span> (line <span class="line-number">1345</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all recipients assigned in the BCC array. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearBCCs
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearCCs" id="ClearCCs"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearCCs</span> (line <span class="line-number">1337</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all recipients assigned in the CC array. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearCCs
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearCustomHeaders" id="ClearCustomHeaders"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearCustomHeaders</span> (line <span class="line-number">1381</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all custom headers. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearCustomHeaders
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodClearReplyTos" id="ClearReplyTos"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">ClearReplyTos</span> (line <span class="line-number">1353</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Clears all recipients assigned in the ReplyTo array. Returns void.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ ClearReplyTos
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodIsError" id="IsError"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">IsError</span> (line <span class="line-number">1505</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns true if an error occurred.</p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ IsError
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodIsHTML" id="IsHTML"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">IsHTML</span> (line <span class="line-number">236</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets message type to HTML.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ IsHTML
+ </span>
+ (<span class="var-type">bool</span> <span class="var-name">$bool</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$bool</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodIsMail" id="IsMail"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">IsMail</span> (line <span class="line-number">255</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets Mailer to send message using PHP mail() function.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ IsMail
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodIsQmail" id="IsQmail"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">IsQmail</span> (line <span class="line-number">271</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets Mailer to send message using the qmail MTA.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ IsQmail
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodIsSendmail" id="IsSendmail"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">IsSendmail</span> (line <span class="line-number">263</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets Mailer to send message using the $Sendmail program.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ IsSendmail
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodIsSMTP" id="IsSMTP"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">IsSMTP</span> (line <span class="line-number">247</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets Mailer to send message using SMTP.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ IsSMTP
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodSend" id="Send"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Send</span> (line <span class="line-number">344</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Send
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodSetLanguage" id="SetLanguage"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">SetLanguage</span> (line <span class="line-number">599</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ SetLanguage
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$lang_type</span>, [<span class="var-type">string</span> <span class="var-name">$lang_path</span> = <span class="var-default">""</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$lang_type</span><span class="var-description">: <p>Type of language (e.g. Portuguese: "br")</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$lang_path</span><span class="var-description">: <p>Path to the language file directory</p></span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodSmtpClose" id="SmtpClose"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">SmtpClose</span> (line <span class="line-number">579</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Closes the active SMTP session if one exists.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ SmtpClose
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class SMTP</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class SMTP</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> <p>Chris Ryan</p></li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_class_smtp_php.html">Program_Root/class.smtp.php</a> (line <span class="field">24</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">string</span>
+ <a href="#$CRLF" title="details" class="var-name">$CRLF</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">bool</span>
+ <a href="#$do_debug" title="details" class="var-name">$do_debug</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">int</span>
+ <a href="#$SMTP_PORT" title="details" class="var-name">$SMTP_PORT</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+
+ |
+ <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#SMTP" title="details" class="method-name">SMTP</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Authenticate" title="details" class="method-name">Authenticate</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$username</span>, <span class="var-type">mixed</span> <span class="var-name">$password</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#Close" title="details" class="method-name">Close</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Connect" title="details" class="method-name">Connect</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$host</span>, <span class="var-type">mixed</span> <span class="var-name">$port</span>, [<span class="var-type">mixed</span> <span class="var-name">$tval</span> = <span class="var-default">30</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Data" title="details" class="method-name">Data</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$msg_data</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#Expand" title="details" class="method-name">Expand</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$name</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Hello" title="details" class="method-name">Hello</a>
+ ([<span class="var-type">mixed</span> <span class="var-name">$host</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#Help" title="details" class="method-name">Help</a>
+ ([<span class="var-type">mixed</span> <span class="var-name">$keyword</span> = <span class="var-default">""</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Mail" title="details" class="method-name">Mail</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Noop" title="details" class="method-name">Noop</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Quit" title="details" class="method-name">Quit</a>
+ ([<span class="var-type">mixed</span> <span class="var-name">$close_on_error</span> = <span class="var-default">true</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Recipient" title="details" class="method-name">Recipient</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$to</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Reset" title="details" class="method-name">Reset</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Send" title="details" class="method-name">Send</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#SendAndMail" title="details" class="method-name">SendAndMail</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#SendOrMail" title="details" class="method-name">SendOrMail</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">bool</span>
+ <a href="#Turn" title="details" class="method-name">Turn</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">int</span>
+ <a href="#Verify" title="details" class="method-name">Verify</a>
+ (<span class="var-type">mixed</span> <span class="var-name">$name</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$CRLF" id="$CRLF"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">string</span>
+ <span class="var-name">$CRLF</span>
+ = <span class="var-default"> "\r\n"</span> (line <span class="line-number">36</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">SMTP reply line ending</p>
+
+
+
+
+
+</div>
+<a name="var$do_debug" id="$do_debug"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">bool</span>
+ <span class="var-name">$do_debug</span>
+ (line <span class="line-number">42</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets whether debugging is turned on</p>
+
+
+
+
+
+</div>
+<a name="var$SMTP_PORT" id="$SMTP_PORT"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">int</span>
+ <span class="var-name">$SMTP_PORT</span>
+ = <span class="var-default"> 25</span> (line <span class="line-number">30</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">SMTP server port</p>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+<a name="methodSMTP" id="SMTP"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor SMTP</span> (line <span class="line-number">57</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Initialize the class so that the data is in a known state.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ SMTP
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodAuthenticate" id="Authenticate"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Authenticate</span> (line <span class="line-number">144</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Authenticate
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$username</span>, <span class="var-type">mixed</span> <span class="var-name">$password</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodClose" id="Close"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Close</span> (line <span class="line-number">232</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Closes the socket and cleans up the state of the class.</p>
+<p class="description"><p>It is not considered good to use this function without first trying to use QUIT.</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ Close
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodConnect" id="Connect"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Connect</span> (line <span class="line-number">82</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Connect to the server specified on the port specified.</p>
+<p class="description"><p>If the port is not specified use the default SMTP_PORT. If tval is specified then a connection will try and be established with the server for that number of seconds. If tval is not specified the default is 30 seconds to try on the connection.</p><p>SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Connect
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$host</span>, <span class="var-type">mixed</span> <span class="var-name">$port</span>, [<span class="var-type">mixed</span> <span class="var-name">$tval</span> = <span class="var-default">30</span>])
+ </div>
+
+
+
+ </div>
+<a name="methodData" id="Data"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Data</span> (line <span class="line-number">266</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Issues a data command and sends the msg_data to the server</p>
+<p class="description"><p>finializing the mail transaction. $msg_data is the message that is to be send with the headers. Each header needs to be on a single line followed by a <CRLF> with the message headers and the message body being seperated by and additional <CRLF>.</p><p>Implements rfc 821: DATA <CRLF></p><p>SMTP CODE INTERMEDIATE: 354 [data] <CRLF>.<CRLF> SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP CODE ERROR : 500,501,503,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Data
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$msg_data</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodExpand" id="Expand"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Expand</span> (line <span class="line-number">399</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+<p class="description"><p>Each value in the array returned has the format of: [ <full-name> <sp> ] <path> The definition of <path> is defined in rfc 821</p><p>Implements rfc 821: EXPN <SP> <string> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 550 SMTP CODE ERROR : 500,501,502,504,421</p></p>
+ <ul class="tags">
+ <li><span class="field">return:</span> <p>array</p></li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ Expand
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$name</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodHello" id="Hello"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Hello</span> (line <span class="line-number">450</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sends the HELO command to the smtp server.</p>
+<p class="description"><p>This makes sure that we and the server are in the same known state.</p><p>Implements from rfc 821: HELO <SP> <domain> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Hello
+ </span>
+ ([<span class="var-type">mixed</span> <span class="var-name">$host</span> = <span class="var-default">""</span>])
+ </div>
+
+
+
+ </div>
+<a name="methodHelp" id="Help"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Help</span> (line <span class="line-number">524</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Gets help information on the keyword specified. If the keyword</p>
+<p class="description"><p>is not specified then returns generic help, ussually contianing A list of keywords that help is available on. This function returns the results back to the user. It is up to the user to handle the returned data. If an error occurs then false is returned with $this->error set appropiately.</p><p>Implements rfc 821: HELP [ <SP> <string> ] <CRLF></p><p>SMTP CODE SUCCESS: 211,214 SMTP CODE ERROR : 500,501,502,504,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ Help
+ </span>
+ ([<span class="var-type">mixed</span> <span class="var-name">$keyword</span> = <span class="var-default">""</span>])
+ </div>
+
+
+
+ </div>
+<a name="methodMail" id="Mail"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Mail</span> (line <span class="line-number">576</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+<p class="description"><p>Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Mail
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodNoop" id="Noop"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Noop</span> (line <span class="line-number">618</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sends the command NOOP to the SMTP server.</p>
+<p class="description"><p>Implements from rfc 821: NOOP <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Noop
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodQuit" id="Quit"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Quit</span> (line <span class="line-number">661</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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.</p>
+<p class="description"><p>Implements from rfc 821: QUIT <CRLF></p><p>SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Quit
+ </span>
+ ([<span class="var-type">mixed</span> <span class="var-name">$close_on_error</span> = <span class="var-default">true</span>])
+ </div>
+
+
+
+ </div>
+<a name="methodRecipient" id="Recipient"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Recipient</span> (line <span class="line-number">715</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</p>
+<p class="description"><p>Returns true if the recipient was accepted false if it was rejected.</p><p>Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF></p><p>SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452 SMTP CODE ERROR : 500,501,503,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Recipient
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$to</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodReset" id="Reset"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Reset</span> (line <span class="line-number">759</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</p>
+<p class="description"><p>Implements rfc 821: RSET <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Reset
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodSend" id="Send"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Send</span> (line <span class="line-number">808</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Starts a mail transaction from the email address specified in</p>
+<p class="description"><p>$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. This command will send the message to the users terminal if they are logged in.</p><p>Implements rfc 821: SEND <SP> FROM:<reverse-path> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Send
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodSendAndMail" id="SendAndMail"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">SendAndMail</span> (line <span class="line-number">856</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Starts a mail transaction from the email address specified in</p>
+<p class="description"><p>$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. This command will send the message to the users terminal if they are logged in and send them an email.</p><p>Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ SendAndMail
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodSendOrMail" id="SendOrMail"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">SendOrMail</span> (line <span class="line-number">904</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Starts a mail transaction from the email address specified in</p>
+<p class="description"><p>$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. This command will send the message to the users terminal if they are logged in or mail it to them if they are not.</p><p>Implements rfc 821: SOML <SP> FROM:<reverse-path> <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ SendOrMail
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$from</span>)
+ </div>
+
+
+
+ </div>
+<a name="methodTurn" id="Turn"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Turn</span> (line <span class="line-number">949</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">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</p>
+<p class="description"><p>Implements from rfc 821: TURN <CRLF></p><p>SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ Turn
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodVerify" id="Verify"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Verify</span> (line <span class="line-number">971</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Verifies that the name is recognized by the server.</p>
+<p class="description"><p>Returns false if the name could not be verified otherwise the response from the server is returned.</p><p>Implements rfc 821: VRFY <SP> <string> <CRLF></p><p>SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,553 SMTP CODE ERROR : 500,501,502,421</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">int</span>
+ <span class="method-name">
+ Verify
+ </span>
+ (<span class="var-type">mixed</span> <span class="var-name">$name</span>)
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs for page class.phpmailer.php</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="file-name">Program_Root/class.phpmailer.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-classes">Classes</a>
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+
+ </div>
+</div>
+
+ <a name="sec-classes"></a>
+ <div class="info-box">
+ <div class="info-box-title">Classes</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Classes</span>
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2" cellspacing="0" class="class-table">
+ <tr>
+ <th class="class-table-header">Class</th>
+ <th class="class-table-header">Description</th>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em; vertical-align: top">
+ <a href="../PHPMailer/PHPMailer.html">PHPMailer</a>
+ </td>
+ <td>
+ PHPMailer - PHP email transport class
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+
+
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs for page class.smtp.php</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="file-name">Program_Root/class.smtp.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-classes">Classes</a>
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+
+ </div>
+</div>
+
+ <a name="sec-classes"></a>
+ <div class="info-box">
+ <div class="info-box-title">Classes</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Classes</span>
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2" cellspacing="0" class="class-table">
+ <tr>
+ <th class="class-table-header">Class</th>
+ <th class="class-table-header">Description</th>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em; vertical-align: top">
+ <a href="../PHPMailer/SMTP.html">SMTP</a>
+ </td>
+ <td>
+ 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.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+
+
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
--- /dev/null
+<html>
+<head>
+ <title>Generated Documentation</title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+</head>
+<body>
+<div align="center"><h1>Generated Documentation</h1></div>
+<b>Welcome to default!</b><br />
+<br />
+This documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor v1.2.0</a><br />
+</body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title></title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+
+<!-- Start of Class Data -->
+<H2>
+
+</H2>
+<h2>Root class PHPMailer</h2>
+<ul>
+<li><a href="PHPMailer/PHPMailer.html">PHPMailer</a></li></ul>
+
+<h2>Root class SMTP</h2>
+<ul>
+<li><a href="PHPMailer/SMTP.html">SMTP</a></li></ul>
+
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title></title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <a name="top"></a>
+<h2>Full index</h2>
+<h3>Package indexes</h3>
+<ul>
+ <li><a href="elementindex_PHPMailer.html">PHPMailer</a></li>
+</ul>
+<br />
+<div class="index-letter-menu">
+ <a class="index-letter" href="elementindex.html#a">a</a>
+ <a class="index-letter" href="elementindex.html#b">b</a>
+ <a class="index-letter" href="elementindex.html#c">c</a>
+ <a class="index-letter" href="elementindex.html#d">d</a>
+ <a class="index-letter" href="elementindex.html#e">e</a>
+ <a class="index-letter" href="elementindex.html#f">f</a>
+ <a class="index-letter" href="elementindex.html#h">h</a>
+ <a class="index-letter" href="elementindex.html#i">i</a>
+ <a class="index-letter" href="elementindex.html#m">m</a>
+ <a class="index-letter" href="elementindex.html#n">n</a>
+ <a class="index-letter" href="elementindex.html#p">p</a>
+ <a class="index-letter" href="elementindex.html#q">q</a>
+ <a class="index-letter" href="elementindex.html#r">r</a>
+ <a class="index-letter" href="elementindex.html#s">s</a>
+ <a class="index-letter" href="elementindex.html#t">t</a>
+ <a class="index-letter" href="elementindex.html#u">u</a>
+ <a class="index-letter" href="elementindex.html#v">v</a>
+ <a class="index-letter" href="elementindex.html#w">w</a>
+</div>
+
+ <a name="a"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">a</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$AltBody</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddAddress</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "To" address.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddAttachment</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds an attachment from a path on the filesystem.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddBCC</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddCC</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddCustomHeader</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a custom header.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddEmbeddedImage</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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".</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddReplyTo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Reply-to" address.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddStringAttachment</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Authenticate</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div>
+ <div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div>
+ </dd>
+ </dl>
+ <a name="b"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">b</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Body</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div>
+ </dd>
+ </dl>
+ <a name="c"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">c</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$CharSet</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the CharSet of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ConfirmReadingTo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ContentType</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Content-type of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$CRLF</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div>
+ <div class="index-item-description">SMTP reply line ending</div>
+ </dd>
+ <dt class="field">
+ <span class="include-title">class.phpmailer.php</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div>
+ </dd>
+ <dt class="field">
+ <span class="include-title">class.smtp.php</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAddresses</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAllRecipients</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAttachments</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearBCCs</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearCCs</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearCustomHeaders</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all custom headers. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearReplyTos</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Close</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div>
+ <div class="index-item-description">Closes the socket and cleans up the state of the class.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Connect</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div>
+ <div class="index-item-description">Connect to the server specified on the port specified.</div>
+ </dd>
+ </dl>
+ <a name="d"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">d</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$do_debug</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div>
+ <div class="index-item-description">Sets whether debugging is turned on</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Data</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div>
+ <div class="index-item-description">Issues a data command and sends the msg_data to the server</div>
+ </dd>
+ </dl>
+ <a name="e"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">e</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Encoding</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ErrorInfo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Holds the most recent mailer error message.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Expand</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="f"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">f</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$From</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the From email address for the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$FromName</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the From name of the message.</div>
+ </dd>
+ </dl>
+ <a name="h"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">h</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Helo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Host</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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").</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Hostname</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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'.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Hello</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the HELO command to the smtp server.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Help</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div>
+ <div class="index-item-description">Gets help information on the keyword specified. If the keyword</div>
+ </dd>
+ </dl>
+ <a name="i"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">i</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">IsError</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Returns true if an error occurred.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsHTML</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets message type to HTML.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsQmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsSendmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsSMTP</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using SMTP.</div>
+ </dd>
+ </dl>
+ <a name="m"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">m</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Mailer</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Method to send mail: ("mail", "sendmail", or "smtp").</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Mail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="n"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">n</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Noop</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the command NOOP to the SMTP server.</div>
+ </dd>
+ </dl>
+ <a name="p"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">p</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Password</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP password.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$PluginDir</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Port</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the default SMTP server port.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Priority</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div>
+ </dd>
+ <dt class="field">
+ PHPMailer
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div>
+ <div class="index-item-description">PHPMailer - PHP email transport class</div>
+ </dd>
+ </dl>
+ <a name="q"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">q</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Quit</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="r"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">r</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Recipient</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Reset</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div>
+ </dd>
+ </dl>
+ <a name="s"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">s</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Sender</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Sendmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the path of the sendmail program.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPAuth</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPDebug</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP class debugging on or off.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPKeepAlive</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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().</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTP_PORT</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div>
+ <div class="index-item-description">SMTP server port</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Subject</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Subject of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Send</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Send</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SendAndMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SendOrMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SetLanguage</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SMTP</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div>
+ <div class="index-item-description">Initialize the class so that the data is in a known state.</div>
+ </dd>
+ <dt class="field">
+ SMTP
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SmtpClose</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Closes the active SMTP session if one exists.</div>
+ </dd>
+ </dl>
+ <a name="t"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">t</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Timeout</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Turn</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div>
+ <div class="index-item-description">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</div>
+ </dd>
+ </dl>
+ <a name="u"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">u</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Username</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP username.</div>
+ </dd>
+ </dl>
+ <a name="v"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">v</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Version</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Holds PHPMailer version.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Verify</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div>
+ <div class="index-item-description">Verifies that the name is recognized by the server.</div>
+ </dd>
+ </dl>
+ <a name="w"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">w</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$WordWrap</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div>
+ </dd>
+ </dl>
+
+<div class="index-letter-menu">
+ <a class="index-letter" href="elementindex.html#a">a</a>
+ <a class="index-letter" href="elementindex.html#b">b</a>
+ <a class="index-letter" href="elementindex.html#c">c</a>
+ <a class="index-letter" href="elementindex.html#d">d</a>
+ <a class="index-letter" href="elementindex.html#e">e</a>
+ <a class="index-letter" href="elementindex.html#f">f</a>
+ <a class="index-letter" href="elementindex.html#h">h</a>
+ <a class="index-letter" href="elementindex.html#i">i</a>
+ <a class="index-letter" href="elementindex.html#m">m</a>
+ <a class="index-letter" href="elementindex.html#n">n</a>
+ <a class="index-letter" href="elementindex.html#p">p</a>
+ <a class="index-letter" href="elementindex.html#q">q</a>
+ <a class="index-letter" href="elementindex.html#r">r</a>
+ <a class="index-letter" href="elementindex.html#s">s</a>
+ <a class="index-letter" href="elementindex.html#t">t</a>
+ <a class="index-letter" href="elementindex.html#u">u</a>
+ <a class="index-letter" href="elementindex.html#v">v</a>
+ <a class="index-letter" href="elementindex.html#w">w</a>
+</div> </body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title></title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <a name="top"></a>
+<h2>[PHPMailer] element index</h2>
+<a href="elementindex.html">All elements</a>
+<br />
+<div class="index-letter-menu">
+ <a class="index-letter" href="elementindex_PHPMailer.html#a">a</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#b">b</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#c">c</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#d">d</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#e">e</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#f">f</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#h">h</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#i">i</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#m">m</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#n">n</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#p">p</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#q">q</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#r">r</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#s">s</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#t">t</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#u">u</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#v">v</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#w">w</a>
+</div>
+
+ <a name="a"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">a</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$AltBody</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddAddress</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "To" address.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddAttachment</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds an attachment from a path on the filesystem.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddBCC</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddCC</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddCustomHeader</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a custom header.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddEmbeddedImage</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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".</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddReplyTo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a "Reply-to" address.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">AddStringAttachment</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Authenticate</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div>
+ <div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div>
+ </dd>
+ </dl>
+ <a name="b"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">b</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Body</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div>
+ </dd>
+ </dl>
+ <a name="c"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">c</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$CharSet</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the CharSet of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ConfirmReadingTo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ContentType</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Content-type of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$CRLF</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div>
+ <div class="index-item-description">SMTP reply line ending</div>
+ </dd>
+ <dt class="field">
+ <span class="include-title">class.phpmailer.php</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div>
+ </dd>
+ <dt class="field">
+ <span class="include-title">class.smtp.php</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAddresses</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAllRecipients</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearAttachments</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearBCCs</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearCCs</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearCustomHeaders</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all custom headers. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">ClearReplyTos</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Close</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div>
+ <div class="index-item-description">Closes the socket and cleans up the state of the class.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Connect</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div>
+ <div class="index-item-description">Connect to the server specified on the port specified.</div>
+ </dd>
+ </dl>
+ <a name="d"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">d</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$do_debug</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div>
+ <div class="index-item-description">Sets whether debugging is turned on</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Data</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div>
+ <div class="index-item-description">Issues a data command and sends the msg_data to the server</div>
+ </dd>
+ </dl>
+ <a name="e"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">e</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Encoding</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$ErrorInfo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Holds the most recent mailer error message.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Expand</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="f"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">f</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$From</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the From email address for the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$FromName</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the From name of the message.</div>
+ </dd>
+ </dl>
+ <a name="h"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">h</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Helo</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Host</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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").</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Hostname</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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'.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Hello</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the HELO command to the smtp server.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Help</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div>
+ <div class="index-item-description">Gets help information on the keyword specified. If the keyword</div>
+ </dd>
+ </dl>
+ <a name="i"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">i</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">IsError</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Returns true if an error occurred.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsHTML</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets message type to HTML.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsQmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsSendmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">IsSMTP</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets Mailer to send message using SMTP.</div>
+ </dd>
+ </dl>
+ <a name="m"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">m</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Mailer</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Method to send mail: ("mail", "sendmail", or "smtp").</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Mail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="n"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">n</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Noop</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the command NOOP to the SMTP server.</div>
+ </dd>
+ </dl>
+ <a name="p"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">p</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Password</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP password.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$PluginDir</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Port</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the default SMTP server port.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Priority</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div>
+ </dd>
+ <dt class="field">
+ PHPMailer
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div>
+ <div class="index-item-description">PHPMailer - PHP email transport class</div>
+ </dd>
+ </dl>
+ <a name="q"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">q</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Quit</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ </dl>
+ <a name="r"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">r</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="method-title">Recipient</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Reset</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div>
+ <div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div>
+ </dd>
+ </dl>
+ <a name="s"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">s</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Sender</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Sendmail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the path of the sendmail program.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPAuth</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPDebug</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP class debugging on or off.</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTPKeepAlive</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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().</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$SMTP_PORT</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div>
+ <div class="index-item-description">SMTP server port</div>
+ </dd>
+ <dt class="field">
+ <span class="var-title">$Subject</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the Subject of the message.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Send</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Send</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SendAndMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SendOrMail</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div>
+ <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SetLanguage</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SMTP</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div>
+ <div class="index-item-description">Initialize the class so that the data is in a known state.</div>
+ </dd>
+ <dt class="field">
+ SMTP
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div>
+ <div class="index-item-description">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.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">SmtpClose</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Closes the active SMTP session if one exists.</div>
+ </dd>
+ </dl>
+ <a name="t"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">t</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Timeout</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Turn</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div>
+ <div class="index-item-description">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</div>
+ </dd>
+ </dl>
+ <a name="u"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">u</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Username</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets SMTP username.</div>
+ </dd>
+ </dl>
+ <a name="v"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">v</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$Version</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Holds PHPMailer version.</div>
+ </dd>
+ <dt class="field">
+ <span class="method-title">Verify</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div>
+ <div class="index-item-description">Verifies that the name is recognized by the server.</div>
+ </dd>
+ </dl>
+ <a name="w"></a>
+ <div class="index-letter-section">
+ <div style="float: left" class="index-letter-title">w</div>
+ <div style="float: right"><a href="#top">top</a></div>
+ <div style="clear: both"></div>
+ </div>
+ <dl>
+ <dt class="field">
+ <span class="var-title">$WordWrap</span>
+ </dt>
+ <dd class="index-item-body">
+ <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div>
+ <div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div>
+ </dd>
+ </dl>
+
+<div class="index-letter-menu">
+ <a class="index-letter" href="elementindex_PHPMailer.html#a">a</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#b">b</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#c">c</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#d">d</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#e">e</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#f">f</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#h">h</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#i">i</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#m">m</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#n">n</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#p">p</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#q">q</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#r">r</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#s">s</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#t">t</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#u">u</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#v">v</a>
+ <a class="index-letter" href="elementindex_PHPMailer.html#w">w</a>
+</div> </body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>phpDocumentor Parser Errors and Warnings</title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <a href="#Post-parsing">Post-parsing</a><br>
+<a href="#class.smtp.php">class.smtp.php</a><br>
+<h1>class.phpmailer.php</h1>
+<h2>Warnings:</h2><br>
+<b>Warning on line 1530</b> - no @package tag was used in a DocBlock for file C:\dev\phpDocumentor-1.2.0\Classes\class.phpmailer.php<br>
+<h1>class.smtp.php</h1>
+<h2>Warnings:</h2><br>
+<b>Warning on line 1039</b> - no @package tag was used in a DocBlock for file C:\dev\phpDocumentor-1.2.0\Classes\class.smtp.php<br>
+ <p class="notes" id="credit">
+ Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
+ </p>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//FR"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+ <!-- Generated by phpDocumentor on Mon, 28 Jul 2003 23:25:49 -0400 -->
+ <title>Generated Documentation</title>
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+</head>
+
+<FRAMESET rows='100,*'>
+ <FRAME src='packages.html' name='left_top' frameborder="1" bordercolor="#999999">
+ <FRAMESET cols='25%,*'>
+ <FRAME src='li_PHPMailer.html' name='left_bottom' frameborder="1" bordercolor="#999999">
+ <FRAME src='blank.html' name='right' frameborder="1" bordercolor="#999999">
+ </FRAMESET>
+ <NOFRAMES>
+ <H2>Frame Alert</H2>
+ <P>This document is designed to be viewed using the frames feature.
+ If you see this message, you are using a non-frame-capable web client.</P>
+ </NOFRAMES>
+</FRAMESET>
+</HTML>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title></title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="package-title">PHPMailer</div>
+<div class="package-details">
+
+ <dl class="tree">
+
+ <dt class="folder-title">Description</dt>
+ <dd>
+ <a href='classtrees_PHPMailer.html' target='right'>Class trees</a><br />
+ <a href='elementindex_PHPMailer.html' target='right'>Index of elements</a><br />
+ </dd>
+
+
+
+ <dt class="folder-title">Classes</dt>
+ <dd><a href='PHPMailer/PHPMailer.html' target='right'>PHPMailer</a></dd>
+ <dd><a href='PHPMailer/SMTP.html' target='right'>SMTP</a></dd>
+ <dt class="folder-title">Files</dt>
+ <dd><a href='PHPMailer/_class_phpmailer_php.html' target='right'>class.phpmailer.php</a></dd>
+ <dd><a href='PHPMailer/_class_smtp_php.html' target='right'>class.smtp.php</a></dd>
+
+
+ </dl>
+</div>
+<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.2.0</span></a></p>
+</BODY>
+</HTML>
\ No newline at end of file
--- /dev/null
+body
+{
+ background-color: #CCCCFF;
+ margin: 0px;
+ padding: 0px;
+}
+
+/* Banner (top bar) classes */
+
+.banner { }
+
+.banner-menu
+{
+ clear: both;
+ padding: .5em;
+ border-top: 2px solid #6666AA;
+}
+
+.banner-title
+{
+ text-align: right;
+ font-size: 20pt;
+ font-weight: bold;
+ margin: .2em;
+}
+
+.package-selector
+{
+ background-color: #AAAADD;
+ border: 1px solid black;
+ color: yellow;
+}
--- /dev/null
+a { color: #336699; text-decoration: none; }
+a:hover { color: #6699CC; text-decoration: underline; }
+a:active { color: #6699CC; text-decoration: underline; }
+
+body, table { font-family: Georgia, Times New Roman, Times, serif; font-size: 10pt }
+p, li { line-height: 140% }
+a img { border: 0px; }
+dd { margin-left: 0px; padding-left: 1em; }
+
+/* Page layout/boxes */
+
+.info-box {}
+.info-box-title { margin: 1em 0em 0em 0em; padding: .25em; font-weight: normal; font-size: 14pt; border: 2px solid #999999; background-color: #CCCCFF }
+.info-box-body { border: 1px solid #999999; padding: .5em; }
+.nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }
+
+.oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
+.evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
+
+.page-body { max-width: 800px; margin: auto; }
+.tree dl { margin: 0px }
+
+/* Index formatting classes */
+
+.index-item-body { margin-top: .5em; margin-bottom: .5em}
+.index-item-description { margin-top: .25em }
+.index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
+.index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
+.index-letter-title { font-size: 12pt; font-weight: bold }
+.index-letter-menu { text-align: center; margin: 1em }
+.index-letter { font-size: 12pt }
+
+/* Docbook classes */
+
+.description {}
+.short-description { font-weight: bold; color: #666666; }
+.tags { padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
+.parameters { padding-left: 0em; margin-left: 3em; font-style: italic; list-style-type: square; }
+.redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
+.package { }
+.package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
+.package-details { font-size: 85%; }
+.sub-package { font-weight: bold; font-size: 120% }
+.tutorial { border-width: thin; border-color: #0066ff }
+.tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
+.nav-button-disabled { color: #999999; }
+.nav-button:active,
+.nav-button:focus,
+.nav-button:hover { background-color: #DDDDDD; outline: 1px solid #999999; text-decoration: none }
+.folder-title { font-style: italic }
+
+/* Generic formatting */
+
+.field { font-weight: bold; }
+.detail { font-size: 8pt; }
+.notes { font-style: italic; font-size: 8pt; }
+.separator { background-color: #999999; height: 2px; }
+.warning { color: #FF6600; }
+.disabled { font-style: italic; color: #999999; }
+
+/* Code elements */
+
+.line-number { }
+
+.class-table { width: 100%; }
+.class-table-header { border-bottom: 1px dotted #666666; text-align: left}
+.class-name { color: #000000; font-weight: bold; }
+
+.method-summary { padding-left: 1em; font-size: 8pt }
+.method-header { }
+.method-definition { margin-bottom: .3em }
+.method-title { font-weight: bold; }
+.method-name { font-weight: bold; }
+.method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
+.method-result { font-style: italic; }
+
+.var-summary { padding-left: 1em; font-size: 8pt; }
+.var-header { }
+.var-title { margin-bottom: .3em }
+.var-type { font-style: italic; }
+.var-name { font-weight: bold; }
+.var-default {}
+.var-description { font-weight: normal; color: #000000; }
+
+.include-title { }
+.include-type { font-style: italic; }
+.include-name { font-weight: bold; }
+
+.const-title { }
+.const-name { font-weight: bold; }
+
+/* Syntax highlighting */
+
+.src-code { border: 1px solid #336699; padding: 1em; background-color: #EEEEEE; }
+
+.src-comm { color: green; }
+.src-id { }
+.src-inc { color: #0000FF; }
+.src-key { color: #0000FF; }
+.src-num { color: #CC0000; }
+.src-str { color: #66cccc; }
+.src-sym { font-weight: bold; }
+.src-var { }
+
+.src-php { font-weight: bold; }
+
+.src-doc { color: #009999 }
+.src-doc-close-template { color: #0000FF }
+.src-doc-coretag { color: #0099FF; font-weight: bold }
+.src-doc-inlinetag { color: #0099FF }
+.src-doc-internal { color: #6699cc }
+.src-doc-tag { color: #0080CC }
+.src-doc-template { color: #0000FF }
+.src-doc-type { font-style: italic }
+.src-doc-var { font-style: italic }
+
+/* tutorial */
+
+.authors { }
+.author { font-style: italic; font-weight: bold }
+.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
+.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em }
+.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap }
+.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
+.ref-title-box { }
+.ref-title { }
+.ref-purpose { font-style: italic; color: #666666 }
+.ref-synopsis { }
+.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #CCCCFF }
+.cmd-synopsis { margin: 1em 0em }
+.cmd-title { font-weight: bold }
+.toc { margin-left: 2em; padding-left: 0em }
+
--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title></title>
+ <link rel="stylesheet" href="media/stylesheet.css" />
+ <link rel="stylesheet" href="media/banner.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="banner">
+ <div class="banner-title">PHPMailer</div>
+ <div class="banner-menu">
+ <table cellpadding="0" cellspacing="0" style="width: 100%">
+ <tr>
+ <td>
+ </td>
+ <td style="width: 2em"> </td>
+ <td style="text-align: right">
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </body>
+ </html>
\ No newline at end of file
--- /dev/null
+<?php\r
+/*******************\r
+ Unit Test\r
+ Type: phpmailer class\r
+********************/\r
+\r
+$INCLUDE_DIR = "../";\r
+\r
+require("phpunit.php");\r
+require($INCLUDE_DIR . "class.phpmailer.php");\r
+error_reporting(E_ALL);\r
+\r
+/**\r
+ * Performs authentication tests\r
+ */\r
+class phpmailerTest extends TestCase\r
+{\r
+ /**\r
+ * Holds the default phpmailer instance.\r
+ * @private\r
+ * @type object\r
+ */\r
+ var $Mail = false;\r
+\r
+ /**\r
+ * Holds the SMTP mail host.\r
+ * @public\r
+ * @type string\r
+ */\r
+ var $Host = "";\r
+ \r
+ /**\r
+ * Holds the change log.\r
+ * @private\r
+ * @type string array\r
+ */\r
+ var $ChangeLog = array();\r
+ \r
+ /**\r
+ * Holds the note log.\r
+ * @private\r
+ * @type string array\r
+ */\r
+ var $NoteLog = array(); \r
+\r
+ /**\r
+ * Class constuctor.\r
+ */\r
+ function phpmailerTest($name) {\r
+ /* must define this constructor */\r
+ $this->TestCase( $name );\r
+ }\r
+ \r
+ /**\r
+ * Run before each test is started.\r
+ */\r
+ function setUp() {\r
+ global $global_vars;\r
+ global $INCLUDE_DIR;\r
+\r
+ $this->Mail = new PHPMailer();\r
+\r
+ $this->Mail->Priority = 3;\r
+ $this->Mail->Encoding = "8bit";\r
+ $this->Mail->CharSet = "iso-8859-1";\r
+ $this->Mail->From = "unit_test@phpmailer.sf.net";\r
+ $this->Mail->FromName = "Unit Tester";\r
+ $this->Mail->Sender = "";\r
+ $this->Mail->Subject = "Unit Test";\r
+ $this->Mail->Body = "";\r
+ $this->Mail->AltBody = "";\r
+ $this->Mail->WordWrap = 0;\r
+ $this->Mail->Host = $global_vars["mail_host"];\r
+ $this->Mail->Port = 25;\r
+ $this->Mail->Helo = "localhost.localdomain";\r
+ $this->Mail->SMTPAuth = false;\r
+ $this->Mail->Username = "";\r
+ $this->Mail->Password = "";\r
+ $this->Mail->PluginDir = $INCLUDE_DIR;\r
+ $this->Mail->AddReplyTo("no_reply@phpmailer.sf.net", "Reply Guy");\r
+ $this->Mail->Sender = "unit_test@phpmailer.sf.net";\r
+\r
+ if(strlen($this->Mail->Host) > 0)\r
+ $this->Mail->Mailer = "smtp";\r
+ else\r
+ {\r
+ $this->Mail->Mailer = "mail";\r
+ $this->Sender = "unit_test@phpmailer.sf.net";\r
+ }\r
+ \r
+ global $global_vars;\r
+ $this->SetAddress($global_vars["mail_to"], "Test User");\r
+ if(strlen($global_vars["mail_cc"]) > 0)\r
+ $this->SetAddress($global_vars["mail_cc"], "Carbon User", "cc");\r
+ } \r
+\r
+ /**\r
+ * Run after each test is completed.\r
+ */\r
+ function tearDown() {\r
+ // Clean global variables\r
+ $this->Mail = NULL;\r
+ $this->ChangeLog = array();\r
+ $this->NoteLog = array();\r
+ }\r
+\r
+\r
+ /**\r
+ * Build the body of the message in the appropriate format.\r
+ * @private\r
+ * @returns void\r
+ */\r
+ function BuildBody() {\r
+ $this->CheckChanges();\r
+ \r
+ // Determine line endings for message \r
+ if($this->Mail->ContentType == "text/html" || strlen($this->Mail->AltBody) > 0)\r
+ {\r
+ $eol = "<br/>";\r
+ $bullet = "<li>";\r
+ $bullet_start = "<ul>";\r
+ $bullet_end = "</ul>";\r
+ }\r
+ else\r
+ {\r
+ $eol = "\n";\r
+ $bullet = " - ";\r
+ $bullet_start = "";\r
+ $bullet_end = "";\r
+ }\r
+ \r
+ $ReportBody = "";\r
+ \r
+ $ReportBody .= "---------------------" . $eol;\r
+ $ReportBody .= "Unit Test Information" . $eol;\r
+ $ReportBody .= "---------------------" . $eol;\r
+ $ReportBody .= "phpmailer version: " . $this->Mail->Version . $eol;\r
+ $ReportBody .= "Content Type: " . $this->Mail->ContentType . $eol;\r
+ \r
+ if(strlen($this->Mail->Host) > 0)\r
+ $ReportBody .= "Host: " . $this->Mail->Host . $eol;\r
+ \r
+ // If attachments then create an attachment list\r
+ if(count($this->Mail->attachment) > 0)\r
+ {\r
+ $ReportBody .= "Attachments:" . $eol;\r
+ $ReportBody .= $bullet_start;\r
+ for($i = 0; $i < count($this->Mail->attachment); $i++)\r
+ {\r
+ $ReportBody .= $bullet . "Name: " . $this->Mail->attachment[$i][1] . ", ";\r
+ $ReportBody .= "Encoding: " . $this->Mail->attachment[$i][3] . ", ";\r
+ $ReportBody .= "Type: " . $this->Mail->attachment[$i][4] . $eol;\r
+ }\r
+ $ReportBody .= $bullet_end . $eol;\r
+ }\r
+ \r
+ // If there are changes then list them\r
+ if(count($this->ChangeLog) > 0)\r
+ {\r
+ $ReportBody .= "Changes" . $eol;\r
+ $ReportBody .= "-------" . $eol;\r
+\r
+ $ReportBody .= $bullet_start;\r
+ for($i = 0; $i < count($this->ChangeLog); $i++)\r
+ {\r
+ $ReportBody .= $bullet . $this->ChangeLog[$i][0] . " was changed to [" . \r
+ $this->ChangeLog[$i][1] . "]" . $eol;\r
+ }\r
+ $ReportBody .= $bullet_end . $eol . $eol;\r
+ }\r
+ \r
+ // If there are notes then list them\r
+ if(count($this->NoteLog) > 0)\r
+ {\r
+ $ReportBody .= "Notes" . $eol;\r
+ $ReportBody .= "-----" . $eol;\r
+\r
+ $ReportBody .= $bullet_start;\r
+ for($i = 0; $i < count($this->NoteLog); $i++)\r
+ {\r
+ $ReportBody .= $bullet . $this->NoteLog[$i] . $eol;\r
+ }\r
+ $ReportBody .= $bullet_end;\r
+ }\r
+ \r
+ // Re-attach the original body\r
+ $this->Mail->Body .= $eol . $eol . $ReportBody;\r
+ }\r
+ \r
+ /**\r
+ * Check which default settings have been changed for the report.\r
+ * @private\r
+ * @returns void\r
+ */\r
+ function CheckChanges() {\r
+ if($this->Mail->Priority != 3)\r
+ $this->AddChange("Priority", $this->Mail->Priority);\r
+ if($this->Mail->Encoding != "8bit")\r
+ $this->AddChange("Encoding", $this->Mail->Encoding);\r
+ if($this->Mail->CharSet != "iso-8859-1")\r
+ $this->AddChange("CharSet", $this->Mail->CharSet);\r
+ if($this->Mail->Sender != "")\r
+ $this->AddChange("Sender", $this->Mail->Sender);\r
+ if($this->Mail->WordWrap != 0)\r
+ $this->AddChange("WordWrap", $this->Mail->WordWrap);\r
+ if($this->Mail->Mailer != "mail")\r
+ $this->AddChange("Mailer", $this->Mail->Mailer);\r
+ if($this->Mail->Port != 25)\r
+ $this->AddChange("Port", $this->Mail->Port);\r
+ if($this->Mail->Helo != "localhost.localdomain")\r
+ $this->AddChange("Helo", $this->Mail->Helo);\r
+ if($this->Mail->SMTPAuth)\r
+ $this->AddChange("SMTPAuth", "true");\r
+ }\r
+ \r
+ /**\r
+ * Adds a change entry.\r
+ * @private\r
+ * @returns void\r
+ */\r
+ function AddChange($sName, $sNewValue) {\r
+ $cur = count($this->ChangeLog);\r
+ $this->ChangeLog[$cur][0] = $sName;\r
+ $this->ChangeLog[$cur][1] = $sNewValue;\r
+ }\r
+ \r
+ /**\r
+ * Adds a simple note to the message.\r
+ * @public\r
+ * @returns void\r
+ */\r
+ function AddNote($sValue) {\r
+ $this->NoteLog[] = $sValue;\r
+ }\r
+\r
+ /**\r
+ * Adds all of the addresses\r
+ * @public\r
+ * @returns void\r
+ */\r
+ function SetAddress($sAddress, $sName = "", $sType = "to") {\r
+ switch($sType)\r
+ {\r
+ case "to":\r
+ $this->Mail->AddAddress($sAddress, $sName);\r
+ break;\r
+ case "cc":\r
+ $this->Mail->AddCC($sAddress, $sName);\r
+ break;\r
+ case "bcc":\r
+ $this->Mail->AddBCC($sAddress, $sName);\r
+ break;\r
+ }\r
+ }\r
+\r
+ /////////////////////////////////////////////////\r
+ // UNIT TESTS\r
+ /////////////////////////////////////////////////\r
+\r
+ /**\r
+ * Try a plain message.\r
+ */\r
+ function test_WordWrap() {\r
+\r
+ $this->Mail->WordWrap = 40;\r
+ $my_body = "Here is the main body of this message. It should " .\r
+ "be quite a few lines. It should be wrapped at the " .\r
+ "40 characters. Make sure that it is.";\r
+ $nBodyLen = strlen($my_body);\r
+ $my_body .= "\n\nThis is the above body length: " . $nBodyLen;\r
+\r
+ $this->Mail->Body = $my_body;\r
+ $this->Mail->Subject .= ": Wordwrap";\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Try a plain message.\r
+ */\r
+ function test_Low_Priority() {\r
+ \r
+ $this->Mail->Priority = 5;\r
+ $this->Mail->Body = "Here is the main body. There should be " .\r
+ "a reply to address in this message.";\r
+ $this->Mail->Subject .= ": Low Priority";\r
+ $this->Mail->AddReplyTo("nobody@nobody.com", "Nobody (Unit Test)");\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Simple plain file attachment test.\r
+ */\r
+ function test_Multiple_Plain_FileAttachment() {\r
+\r
+ $this->Mail->Body = "Here is the text body";\r
+ $this->Mail->Subject .= ": Plain + Multiple FileAttachments";\r
+\r
+ if(!$this->Mail->AddAttachment("test.png"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ if(!$this->Mail->AddAttachment("phpmailer_test.php", "test.txt"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Simple plain string attachment test.\r
+ */\r
+ function test_Plain_StringAttachment() {\r
+\r
+ $this->Mail->Body = "Here is the text body";\r
+ $this->Mail->Subject .= ": Plain + StringAttachment";\r
+ \r
+ $sAttachment = "These characters are the content of the " .\r
+ "string attachment.\nThis might be taken from a ".\r
+ "database or some other such thing. ";\r
+ \r
+ $this->Mail->AddStringAttachment($sAttachment, "string_attach.txt");\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Plain quoted-printable message.\r
+ */\r
+ function test_Quoted_Printable() {\r
+\r
+ $this->Mail->Body = "Here is the main body";\r
+ $this->Mail->Subject .= ": Plain + Quoted-printable";\r
+ $this->Mail->Encoding = "quoted-printable";\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Try a plain message.\r
+ */\r
+ function test_Html() {\r
+ \r
+ $this->Mail->IsHTML(true);\r
+ $this->Mail->Subject .= ": HTML only";\r
+ \r
+ $this->Mail->Body = "This is a <b>test message</b> written in HTML. </br>" .\r
+ "Go to <a href=\"http://phpmailer.sourceforge.net/\">" .\r
+ "http://phpmailer.sourceforge.net/</a> for new versions of " .\r
+ "phpmailer. <p/> Thank you!";\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Simple HTML and attachment test\r
+ */\r
+ function test_HTML_Attachment() {\r
+\r
+ $this->Mail->Body = "This is the <b>HTML</b> part of the email.";\r
+ $this->Mail->Subject .= ": HTML + Attachment";\r
+ $this->Mail->IsHTML(true);\r
+ \r
+ if(!$this->Mail->AddAttachment("phpmailer_test.php", "test_attach.txt"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * An embedded attachment test.\r
+ */\r
+ function test_Embedded_Image() {\r
+\r
+ $this->Mail->Body = "Embedded Image: <img alt=\"phpmailer\" src=\"cid:my-attach\">" .\r
+ "Here is an image!</a>";\r
+ $this->Mail->Subject .= ": Embedded Image";\r
+ $this->Mail->IsHTML(true);\r
+ \r
+ if(!$this->Mail->AddEmbeddedImage("test.png", "my-attach", "test.png",\r
+ "base64", "image/png"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * An embedded attachment test.\r
+ */\r
+ function test_Multi_Embedded_Image() {\r
+\r
+ $this->Mail->Body = "Embedded Image: <img alt=\"phpmailer\" src=\"cid:my-attach\">" .\r
+ "Here is an image!</a>";\r
+ $this->Mail->Subject .= ": Embedded Image + Attachment";\r
+ $this->Mail->IsHTML(true);\r
+ \r
+ if(!$this->Mail->AddEmbeddedImage("test.png", "my-attach", "test.png",\r
+ "base64", "image/png"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ if(!$this->Mail->AddAttachment("phpmailer_test.php", "test.txt"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+ \r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Simple multipart/alternative test.\r
+ */\r
+ function test_AltBody() {\r
+\r
+ $this->Mail->Body = "This is the <b>HTML</b> part of the email.";\r
+ $this->Mail->AltBody = "Here is the text body of this message. " .\r
+ "It should be quite a few lines. It should be wrapped at the " .\r
+ "40 characters. Make sure that it is.";\r
+ $this->Mail->WordWrap = 40;\r
+ $this->AddNote("This is a mulipart alternative email");\r
+ $this->Mail->Subject .= ": AltBody + Word Wrap";\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ /**\r
+ * Simple HTML and attachment test\r
+ */\r
+ function test_AltBody_Attachment() {\r
+\r
+ $this->Mail->Body = "This is the <b>HTML</b> part of the email.";\r
+ $this->Mail->AltBody = "This is the text part of the email.";\r
+ $this->Mail->Subject .= ": AltBody + Attachment";\r
+ $this->Mail->IsHTML(true);\r
+ \r
+ if(!$this->Mail->AddAttachment("phpmailer_test.php", "test_attach.txt"))\r
+ {\r
+ $this->assert(false, $this->Mail->ErrorInfo);\r
+ return;\r
+ }\r
+\r
+ $this->BuildBody();\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+\r
+ $fp = fopen("message.txt", "w");\r
+ fwrite($fp, $this->Mail->CreateHeader() . $this->Mail->CreateBody());\r
+ fclose($fp);\r
+ } \r
+\r
+ function test_MultipleSend() {\r
+ $this->Mail->Body = "Sending two messages without keepalive";\r
+ $this->BuildBody();\r
+ $subject = $this->Mail->Subject;\r
+\r
+ $this->Mail->Subject = $subject . ": SMTP 1";\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ \r
+ $this->Mail->Subject = $subject . ": SMTP 2";\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+\r
+ function test_SmtpKeepAlive() {\r
+ $this->Mail->Body = "This was done using the SMTP keep-alive.";\r
+ $this->BuildBody();\r
+ $subject = $this->Mail->Subject;\r
+\r
+ $this->Mail->SMTPKeepAlive = true;\r
+ $this->Mail->Subject = $subject . ": SMTP keep-alive 1";\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ \r
+ $this->Mail->Subject = $subject . ": SMTP keep-alive 2";\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ $this->Mail->SmtpClose();\r
+ }\r
+ \r
+ /**\r
+ * Tests this denial of service attack: \r
+ * http://www.cybsec.com/vuln/PHPMailer-DOS.pdf\r
+ */\r
+ function test_DenialOfServiceAttack() {\r
+ $this->Mail->Body = "This should no longer cause a denial of service.";\r
+ $this->BuildBody();\r
+ \r
+ $this->Mail->Subject = str_repeat("A", 998);\r
+ $this->assert($this->Mail->Send(), $this->Mail->ErrorInfo);\r
+ }\r
+ \r
+ function test_Error() {\r
+ $this->Mail->Subject .= ": This should be sent"; \r
+ $this->BuildBody();\r
+ $this->Mail->ClearAllRecipients(); // no addresses should cause an error\r
+ $this->assert($this->Mail->IsError() == false, "Error found");\r
+ $this->assert($this->Mail->Send() == false, "Send succeeded");\r
+ $this->assert($this->Mail->IsError(), "No error found");\r
+ $this->assertEquals('You must provide at least one ' .\r
+ 'recipient email address.', $this->Mail->ErrorInfo);\r
+ $this->Mail->AddAddress(get("mail_to"));\r
+ $this->assert($this->Mail->Send(), "Send failed");\r
+ }\r
+} \r
+ \r
+/**\r
+ * Create and run test instance.\r
+ */\r
+ \r
+if(isset($HTTP_GET_VARS))\r
+ $global_vars = $HTTP_GET_VARS;\r
+else\r
+ $global_vars = $_REQUEST;\r
+\r
+if(isset($global_vars["submitted"]))\r
+{\r
+ echo "Test results:<br>";\r
+ $suite = new TestSuite( "phpmailerTest" );\r
+ \r
+ $testRunner = new TestRunner;\r
+ $testRunner->run($suite);\r
+ echo "<hr noshade/>";\r
+}\r
+\r
+function get($sName) {\r
+ global $global_vars;\r
+ if(isset($global_vars[$sName]))\r
+ return $global_vars[$sName];\r
+ else\r
+ return "";\r
+}\r
+\r
+?>\r
+\r
+<html>\r
+<body>\r
+<h3>phpmailer Unit Test</h3>\r
+By entering a SMTP hostname it will automatically perform tests with SMTP.\r
+\r
+<form name="phpmailer_unit" action="phpmailer_test.php" method="get">\r
+<input type="hidden" name="submitted" value="1"/>\r
+To Address: <input type="text" size="50" name="mail_to" value="<?php echo get("mail_to"); ?>"/>\r
+<br/>\r
+Cc Address: <input type="text" size="50" name="mail_cc" value="<?php echo get("mail_cc"); ?>"/>\r
+<br/>\r
+SMTP Hostname: <input type="text" size="50" name="mail_host" value="<?php echo get("mail_host"); ?>"/>\r
+<p/>\r
+<input type="submit" value="Run Test"/>\r
+\r
+</form>\r
+</body>\r
+</html>\r
--- /dev/null
+<?php\r
+//\r
+// PHP framework for testing, based on the design of "JUnit".\r
+//\r
+// Written by Fred Yankowski <fred@ontosys.com>\r
+// OntoSys, Inc <http://www.OntoSys.com>\r
+//\r
+// $Id: phpunit.php,v 1.1 2002/03/30 19:32:17 bmatzelle Exp $\r
+\r
+// Copyright (c) 2000 Fred Yankowski\r
+\r
+// Permission is hereby granted, free of charge, to any person\r
+// obtaining a copy of this software and associated documentation\r
+// files (the "Software"), to deal in the Software without\r
+// restriction, including without limitation the rights to use, copy,\r
+// modify, merge, publish, distribute, sublicense, and/or sell copies\r
+// of the Software, and to permit persons to whom the Software is\r
+// furnished to do so, subject to the following conditions:\r
+//\r
+// The above copyright notice and this permission notice shall be\r
+// included in all copies or substantial portions of the Software.\r
+//\r
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\r
+// BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\r
+// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r
+// SOFTWARE.\r
+//\r
+error_reporting(E_ERROR | E_WARNING | E_PARSE | E_NOTICE |\r
+ E_CORE_ERROR | E_CORE_WARNING);\r
+\r
+/*\r
+interface Test {\r
+ function run(&$aTestResult);\r
+ function countTestCases();\r
+}\r
+*/\r
+\r
+function trace($msg) {\r
+ return;\r
+ print($msg);\r
+ flush();\r
+}\r
+\r
+\r
+class Exception {\r
+ /* Emulate a Java exception, sort of... */\r
+ var $message;\r
+ function Exception($message) {\r
+ $this->message = $message;\r
+ }\r
+ function getMessage() {\r
+ return $this->message;\r
+ }\r
+}\r
+\r
+class Assert {\r
+ function assert($boolean, $message=0) {\r
+ if (! $boolean)\r
+ $this->fail($message);\r
+ }\r
+\r
+ function assertEquals($expected, $actual, $message=0) {\r
+ if ($expected != $actual) {\r
+ $this->failNotEquals($expected, $actual, "expected", $message);\r
+ }\r
+ }\r
+\r
+ function assertRegexp($regexp, $actual, $message=false) {\r
+ if (! preg_match($regexp, $actual)) {\r
+ $this->failNotEquals($regexp, $actual, "pattern", $message);\r
+ }\r
+ }\r
+\r
+ function failNotEquals($expected, $actual, $expected_label, $message=0) {\r
+ // Private function for reporting failure to match.\r
+ $str = $message ? ($message . ' ') : '';\r
+ $str .= "($expected_label/actual)<br>";\r
+ $htmlExpected = htmlspecialchars($expected);\r
+ $htmlActual = htmlspecialchars($actual);\r
+ $str .= sprintf("<pre>%s\n--------\n%s</pre>",\r
+ $htmlExpected, $htmlActual);\r
+ $this->fail($str);\r
+ }\r
+}\r
+\r
+class TestCase extends Assert /* implements Test */ {\r
+ /* Defines context for running tests. Specific context -- such as\r
+ instance variables, global variables, global state -- is defined\r
+ by creating a subclass that specializes the setUp() and\r
+ tearDown() methods. A specific test is defined by a subclass\r
+ that specializes the runTest() method. */\r
+ var $fName;\r
+ var $fResult;\r
+ var $fExceptions = array();\r
+\r
+ function TestCase($name) {\r
+ $this->fName = $name;\r
+ }\r
+\r
+ function run($testResult=0) {\r
+ /* Run this single test, by calling the run() method of the\r
+ TestResult object which will in turn call the runBare() method\r
+ of this object. That complication allows the TestResult object\r
+ to do various kinds of progress reporting as it invokes each\r
+ test. Create/obtain a TestResult object if none was passed in.\r
+ Note that if a TestResult object was passed in, it must be by\r
+ reference. */\r
+ if (! $testResult)\r
+ $testResult = $this->_createResult();\r
+ $this->fResult = $testResult;\r
+ $testResult->run(&$this);\r
+ $this->fResult = 0;\r
+ return $testResult;\r
+ }\r
+\r
+ function countTestCases() {\r
+ return 1;\r
+ }\r
+\r
+ function runTest() {\r
+ $name = $this->name();\r
+ // Since isset($this->$name) is false, no way to run defensive checks\r
+ $this->$name();\r
+ }\r
+\r
+ function setUp() /* expect override */ {\r
+ //print("TestCase::setUp()<br>\n");\r
+ }\r
+\r
+ function tearDown() /* possible override */ {\r
+ //print("TestCase::tearDown()<br>\n");\r
+ }\r
+\r
+ ////////////////////////////////////////////////////////////////\r
+\r
+\r
+ function _createResult() /* protected */ {\r
+ /* override this to use specialized subclass of TestResult */\r
+ return new TestResult;\r
+ }\r
+\r
+ function fail($message=0) {\r
+ //printf("TestCase::fail(%s)<br>\n", ($message) ? $message : '');\r
+ /* JUnit throws AssertionFailedError here. We just record the\r
+ failure and carry on */\r
+ $this->fExceptions[] = new Exception(&$message);\r
+ }\r
+\r
+ function error($message) {\r
+ /* report error that requires correction in the test script\r
+ itself, or (heaven forbid) in this testing infrastructure */\r
+ printf('<b>ERROR: ' . $message . '</b><br>');\r
+ $this->fResult->stop();\r
+ }\r
+\r
+ function failed() {\r
+ return count($this->fExceptions);\r
+ }\r
+\r
+ function getExceptions() {\r
+ return $this->fExceptions;\r
+ }\r
+\r
+ function name() {\r
+ return $this->fName;\r
+ }\r
+\r
+ function runBare() {\r
+ $this->setup();\r
+ $this->runTest();\r
+ $this->tearDown();\r
+ }\r
+}\r
+\r
+\r
+class TestSuite /* implements Test */ {\r
+ /* Compose a set of Tests (instances of TestCase or TestSuite), and\r
+ run them all. */\r
+ var $fTests = array();\r
+\r
+ function TestSuite($classname=false) {\r
+ if ($classname) {\r
+ // Find all methods of the given class whose name starts with\r
+ // "test" and add them to the test suite. We are just _barely_\r
+ // able to do this with PHP's limited introspection... Note\r
+ // that PHP seems to store method names in lower case, and we\r
+ // have to avoid the constructor function for the TestCase class\r
+ // superclass. This will fail when $classname starts with\r
+ // "Test" since that will have a constructor method that will\r
+ // get matched below and then treated (incorrectly) as a test\r
+ // method. So don't name any TestCase subclasses as "Test..."!\r
+ if (floor(phpversion()) >= 4) {\r
+ // PHP4 introspection, submitted by Dylan Kuhn\r
+ $names = get_class_methods($classname);\r
+ while (list($key, $method) = each($names)) {\r
+ if (preg_match('/^test/', $method) && $method != "testcase") { \r
+ $this->addTest(new $classname($method));\r
+ }\r
+ }\r
+ }\r
+ else {\r
+ $dummy = new $classname("dummy");\r
+ $names = (array) $dummy;\r
+ while (list($key, $value) = each($names)) {\r
+ $type = gettype($value);\r
+ if ($type == "user function" && preg_match('/^test/', $key)\r
+ && $key != "testcase") { \r
+ $this->addTest(new $classname($key));\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ function addTest($test) {\r
+ /* Add TestCase or TestSuite to this TestSuite */\r
+ $this->fTests[] = $test;\r
+ }\r
+\r
+ function run(&$testResult) {\r
+ /* Run all TestCases and TestSuites comprising this TestSuite,\r
+ accumulating results in the given TestResult object. */\r
+ reset($this->fTests);\r
+ while (list($na, $test) = each($this->fTests)) {\r
+ if ($testResult->shouldStop())\r
+ break;\r
+ $test->run(&$testResult);\r
+ }\r
+ }\r
+\r
+ function countTestCases() {\r
+ /* Number of TestCases comprising this TestSuite (including those\r
+ in any constituent TestSuites) */\r
+ $count = 0;\r
+ reset($fTests);\r
+ while (list($na, $test_case) = each($this->fTests)) {\r
+ $count += $test_case->countTestCases();\r
+ }\r
+ return $count;\r
+ }\r
+}\r
+\r
+\r
+class TestFailure {\r
+ /* Record failure of a single TestCase, associating it with the\r
+ exception(s) that occurred */\r
+ var $fFailedTestName;\r
+ var $fExceptions;\r
+\r
+ function TestFailure(&$test, &$exceptions) {\r
+ $this->fFailedTestName = $test->name();\r
+ $this->fExceptions = $exceptions;\r
+ }\r
+\r
+ function getExceptions() {\r
+ return $this->fExceptions;\r
+ }\r
+ function getTestName() {\r
+ return $this->fFailedTestName;\r
+ }\r
+}\r
+\r
+\r
+class TestResult {\r
+ /* Collect the results of running a set of TestCases. */\r
+ var $fFailures = array();\r
+ var $fRunTests = 0;\r
+ var $fStop = false;\r
+\r
+ function TestResult() { }\r
+\r
+ function _endTest($test) /* protected */ {\r
+ /* specialize this for end-of-test action, such as progress\r
+ reports */\r
+ }\r
+\r
+ function getFailures() {\r
+ return $this->fFailures;\r
+ }\r
+\r
+ function run($test) {\r
+ /* Run a single TestCase in the context of this TestResult */\r
+ $this->_startTest($test);\r
+ $this->fRunTests++;\r
+\r
+ $test->runBare();\r
+\r
+ /* this is where JUnit would catch AssertionFailedError */\r
+ $exceptions = $test->getExceptions();\r
+ if ($exceptions)\r
+ $this->fFailures[] = new TestFailure(&$test, &$exceptions);\r
+ $this->_endTest($test);\r
+ }\r
+\r
+ function countTests() {\r
+ return $this->fRunTests;\r
+ }\r
+\r
+ function shouldStop() {\r
+ return $this->fStop;\r
+ }\r
+\r
+ function _startTest($test) /* protected */ {\r
+ /* specialize this for start-of-test actions */\r
+ }\r
+\r
+ function stop() {\r
+ /* set indication that the test sequence should halt */\r
+ $fStop = true;\r
+ }\r
+\r
+ function countFailures() {\r
+ return count($this->fFailures);\r
+ }\r
+}\r
+\r
+\r
+class TextTestResult extends TestResult {\r
+ /* Specialize TestResult to produce text/html report */\r
+ function TextTestResult() {\r
+ $this->TestResult(); // call superclass constructor\r
+ }\r
+ \r
+ function report() {\r
+ /* report result of test run */\r
+ $nRun = $this->countTests();\r
+ $nFailures = $this->countFailures();\r
+ printf("<p>%s test%s run<br>", $nRun, ($nRun == 1) ? '' : 's');\r
+ printf("%s failure%s.<br>\n", $nFailures, ($nFailures == 1) ? '' : 's');\r
+ if ($nFailures == 0)\r
+ return;\r
+\r
+ print("<ol>\n");\r
+ $failures = $this->getFailures();\r
+ while (list($i, $failure) = each($failures)) {\r
+ $failedTestName = $failure->getTestName();\r
+ printf("<li>%s\n", $failedTestName);\r
+\r
+ $exceptions = $failure->getExceptions();\r
+ print("<ul>");\r
+ while (list($na, $exception) = each($exceptions))\r
+ printf("<li>%s\n", $exception->getMessage());\r
+ print("</ul>");\r
+ }\r
+ print("</ol>\n");\r
+ }\r
+\r
+ function _startTest($test) {\r
+ printf("%s ", $test->name());\r
+ flush();\r
+ }\r
+\r
+ function _endTest($test) {\r
+ $outcome = $test->failed()\r
+ ? "<font color=\"red\">FAIL</font>"\r
+ : "<font color=\"green\">ok</font>";\r
+ printf("$outcome<br>\n");\r
+ flush();\r
+ }\r
+}\r
+\r
+\r
+class TestRunner {\r
+ /* Run a suite of tests and report results. */\r
+ function run($suite) {\r
+ $result = new TextTestResult;\r
+ $suite->run($result);\r
+ $result->report();\r
+ }\r
+}\r
+\r
+?>\r
// CFG: USER-STATUS-CLASS
$cfg->setConfigEntry('user_status_class', "UserStatusVerifierFilter");
+// CFG: USER-UNCONFIRMED-CLASS
+$cfg->setConfigEntry('user_unconfirmed_class', "UserUnconfirmedVerifierFilter");
+
// CFG: CRYPTO-HELPER
$cfg->setConfigEntry('crypto_class', "CryptoHelper");
projects / shipsimu.git / commitdiff
