Class src_mail_smtp

Description

This file is part of the htmlMimeMail5 package (http://www.phpguru.org/)

htmlMimeMail5 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 2 of the License, or (at your option) any later version.

htmlMimeMail5 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 htmlMimeMail5; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Located in /src/mail/class.smtp.php (line 43)


	
			
Method Summary
src_mail_smtp __construct ([ $params = array ()])
void connect ([ $params = array ()])
void getErrors ()
void send ([ $params = array ()])
void set ( $var,  $value)
Methods
Constructor __construct (line 75)

Constructor function. Arguments: $params - An assoc array of parameters:

host - The hostname of the smtp server Default: localhost port - The port the smtp server runs on Default: 25 helo - What to send as the HELO command Default: localhost (typically the hostname of the machine this script runs on) auth - Whether to use basic authentication Default: FALSE user - Username for authentication Default: <blank> pass - Password for authentication Default: <blank> timeout - The timeout in seconds for the call Default: 5 to fsockopen()

  • access: public
src_mail_smtp __construct ([ $params = array ()])
  • $params
connect (line 104)

Connect function. This will, when called

statically, create a new smtp object, call the connect function (ie this function) and return it. When not called statically, it will connect to the server and send the HELO command.

  • access: public
void connect ([ $params = array ()])
  • $params
getErrors (line 355)

Function to return the errors array

  • access: public
void getErrors ()
send (line 142)

Function which handles sending the mail.

Arguments: $params - Optional assoc array of parameters. Can contain: recipients - Indexed array of recipients from - The from address. (used in MAIL FROM:), this will be the return path headers - Indexed array of headers, one header per array entry body - The body of the email It can also contain any of the parameters from the connect() function

  • access: public
void send ([ $params = array ()])
  • $params
set (line 347)

Sets a variable

  • access: public
void set ( $var,  $value)
  • $var
  • $value

Documentation generated on Sat, 24 Mar 2007 10:00:05 +0100 by phpDocumentor 1.3.1