

[ class tree: PHPMailer ] [ index: PHPMailer ] [ all elements ]

Class: SMTP

Source Location: /zp-extensions/PHPMailer/class.smtp.php

Class SMTP

Class Overview

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.

original author: Chris Ryan

Located in /zp-extensions/PHPMailer/class.smtp.php [line 49]

Author(s):

API Tags:

Usedby:	PHPMailer::SmtpConnect()
Usedby:	PHPMailer::SmtpSend()

Properties

Methods

[ Top ]

Property Summary

string	$CRLF	SMTP reply line ending
bool	$do_debug	Sets whether debugging is turned on
bool	$do_verp	Sets VERP use on/off (default is off)
int	$SMTP_PORT	SMTP server port

[ Top ]

Method Summary

void	__construct()	Initialize the class so that the data is in a known state.
bool	Authenticate()	Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
void	Close()	Closes the socket and cleans up the state of the class.
bool	Connect()	Connect to the server specified on the port specified.
bool	Connected()	Returns true if connected to a server otherwise false
bool	Data()	Issues a data command and sends the msg_data to the server
array	getError()	Get the current error
bool	Hello()	Sends the HELO command to the smtp server.
bool	Mail()	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.
bool	Quit()	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.
bool	Recipient()	Sends the command RCPT to the SMTP server with the TO: argument of $to.
bool	Reset()	Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.
bool	SendAndMail()	Starts a mail transaction from the email address specified in
bool	StartTLS()	Initiate a TLS communication with the server.
bool	Turn()	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

[ Top ]

Properties

string $CRLF = "\r\n" [line 60]

SMTP reply line ending

API Tags:

Access:

public

[ Top ]

bool $do_debug [line 66]

Sets whether debugging is turned on

API Tags:

Access:

public

[ Top ]

bool $do_verp = false [line 72]

Sets VERP use on/off (default is off)

API Tags:

Access:

public

[ Top ]

int $SMTP_PORT = 25 [line 54]

SMTP server port

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 87]

void __construct(
)

Initialize the class so that the data is in a known state.

API Tags:

Access:

public

[ Top ]

Authenticate [line 210]

bool Authenticate(

$username, 
$password 
)

Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.

Parameters:

	$username:
	$password:

API Tags:

Access:

public

[ Top ]

Close [line 293]

void Close(
)

Closes the socket and cleans up the state of the class.

It is not considered good to use this function without first trying to use QUIT.

API Tags:

Access:

public

[ Top ]

Connect [line 112]

bool Connect(

$host, [
$port = 0], [
$tval = 30] 
)

Connect to the server specified on the port specified.

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.

SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421

Parameters:

	$host:
	$port:
	$tval:

API Tags:

Access:

public

[ Top ]

Connected [line 270]

bool Connected(
)

Returns true if connected to a server otherwise false

API Tags:

Access:

public

[ Top ]

Data [line 326]

bool Data(

$msg_data 
)

Issues a data command and sends the msg_data to the server

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>.

Implements rfc 821: DATA <CRLF>

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

Parameters:

$msg_data:

API Tags:

Access:

public

[ Top ]

getError [line 778]

array getError(
)

Get the current error

API Tags:

Access:

public

[ Top ]

Hello [line 463]

bool Hello(
[
$host = ''] 
)

Sends the HELO command to the smtp server.

This makes sure that we and the server are in the same known state.

Implements from rfc 821: HELO <SP> <domain> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421

Parameters:

$host:

API Tags:

Access:

public

[ Top ]

Mail [line 533]

bool Mail(

$from 
)

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.

Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,421

Parameters:

$from:

API Tags:

Access:

public

[ Top ]

Quit [line 576]

bool Quit(
[
$close_on_error = true] 
)

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.

Implements from rfc 821: QUIT <CRLF>

SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500

Parameters:

$close_on_error:

API Tags:

Access:

public

[ Top ]

Recipient [line 629]

bool Recipient(

$to 
)

Sends the command RCPT to the SMTP server with the TO: argument of $to.

Returns true if the recipient was accepted false if it was rejected.

Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>

SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452 SMTP CODE ERROR : 500,501,503,421

Parameters:

$to:

API Tags:

Access:

public

[ Top ]

Reset [line 672]

bool Reset(
)

Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.

Implements rfc 821: RSET <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421

API Tags:

Access:

public

[ Top ]

SendAndMail [line 720]

bool SendAndMail(

$from 
)

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. This command will send the message to the users terminal if they are logged in and send them an email.

Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421

Parameters:

$from:

API Tags:

Access:

public

[ Top ]

StartTLS [line 168]

bool StartTLS(
)

Initiate a TLS communication with the server.

SMTP CODE 220 Ready to start TLS SMTP CODE 501 Syntax error (no parameters allowed) SMTP CODE 454 TLS not available due to temporary reason

API Tags:

Return:	success
Access:	public

[ Top ]

Turn [line 764]

bool Turn(
)

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

Implements from rfc 821: TURN <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503

API Tags:

Access:

public

[ Top ]

PHPMailer

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

class.phpmailer.php
class.pop3.php
class.smtp.php

Classes:

PHPMailer
phpmailerException
POP3
SMTP

Documentation generated on Tue, 20 Dec 2011 16:07:02 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: SMTP

Class SMTP

RSS feeds!

Social networks

Join the Google Groups!

Information

Legal stuff