contenido\classes\class.smtp.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: PHP SMTP class Define an SMTP class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.

Requirements:

Author
Chris Ryan  
Con_php_req
5.0  
Copyright
Chris Ryan  
License
LGPL, see LICENSE  
Package
Contenido Backend classes  
Since
file available since contenido release <= 4.6 {@internal created unknown modified 2008-06-30, Frederic Schneider, add security fix $Id: class.smtp.php 413 2008-06-30 11:55:36Z frederic.schneider $: }}  
Version
1.0.2  

\SMTP

Package: PHPMailer
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.

Author
Chris Ryan  

Properties

>VPropertypublic$CRLF = "\r\n"
SMTP reply line ending

@var string

Default value"\r\n"Details
Type
n/a
>VPropertypublic$SMTP_PORT = 25
SMTP server port

@var int

Default value25Details
Type
n/a
>VPropertypublic$do_debug
Sets whether debugging is turned on

@var bool

Details
Type
n/a
>VPropertypublic$error
Details
Type
n/a
>VPropertypublic$helo_rply
Details
Type
n/a
>VPropertypublic$smtp_conn
Details
Type
n/a

Methods

methodpublicAuthenticate( $username,  $password) : bool

Performs SMTP authentication.

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

Parameters
NameTypeDescription
$username
$password
Returns
TypeDescription
bool
Details
Access
public  
methodpublicClose() : void

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.

Details
Access
public  
methodpublicConnect( $host,  $port = 0,  $tval = 30) : bool

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
NameTypeDescription
$host
$port
$tval
Returns
TypeDescription
bool
Details
Access
public  
methodpublicConnected() : bool

Returns true if connected to a server otherwise false

Returns
TypeDescription
bool
Details
Access
private  
methodpublicData( $msg_data) : bool

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 with the message headers and the message body being seperated by and additional .

Implements rfc 821: DATA

SMTP CODE INTERMEDIATE: 354 [data] . SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP CODE ERROR : 500,501,503,421

Parameters
NameTypeDescription
$msg_data
Returns
TypeDescription
bool
Details
Access
public  
methodpublicExpand( $name) : string

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. Each value in the array returned has the format of: [ ] The definition of is defined in rfc 821

Implements rfc 821: EXPN

SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 550 SMTP CODE ERROR : 500,501,502,504,421

Parameters
NameTypeDescription
$name
Returns
TypeDescription
stringarray
Details
Access
public  
methodpublicHello( $host = "") : bool

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

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

Parameters
NameTypeDescription
$host
Returns
TypeDescription
bool
Details
Access
public  
methodpublicHelp( $keyword = "") : string

Gets help information on the keyword specified.

If the keyword 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.

Implements rfc 821: HELP [ ]

SMTP CODE SUCCESS: 211,214 SMTP CODE ERROR : 500,501,502,504,421

Parameters
NameTypeDescription
$keyword
Returns
TypeDescription
string
Details
Access
public  
methodpublicMail( $from) : bool

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 FROM:

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

Parameters
NameTypeDescription
$from
Returns
TypeDescription
bool
Details
Access
public  
methodpublicNoop() : bool

Sends the command NOOP to the SMTP server.

Implements from rfc 821: NOOP

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

Returns
TypeDescription
bool
Details
Access
public  
methodpublicQuit( $close_on_error = true) : bool

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

SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500

Parameters
NameTypeDescription
$close_on_error
Returns
TypeDescription
bool
Details
Access
public  
methodpublicRecipient( $to) : bool

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 TO:

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

Parameters
NameTypeDescription
$to
Returns
TypeDescription
bool
Details
Access
public  
methodpublicReset() : bool

Sends the RSET command to abort and transaction that is currently in progress.

Returns true if successful false otherwise.

Implements rfc 821: RSET

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

Returns
TypeDescription
bool
Details
Access
public  
methodpublicSMTP() : void

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

Details
Access
public  
methodpublicSend( $from) : bool

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.

Implements rfc 821: SEND FROM:

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

Parameters
NameTypeDescription
$from
Returns
TypeDescription
bool
Details
Access
public  
methodpublicSendAndMail( $from) : bool

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 FROM:

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

Parameters
NameTypeDescription
$from
Returns
TypeDescription
bool
Details
Access
public  
methodpublicSendHello( $hello,  $host) : bool

Sends a HELO/EHLO command.

Parameters
NameTypeDescription
$hello
$host
Returns
TypeDescription
bool
Details
Access
private  
methodpublicSendOrMail( $from) : bool

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 or mail it to them if they are not.

Implements rfc 821: SOML FROM:

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

Parameters
NameTypeDescription
$from
Returns
TypeDescription
bool
Details
Access
public  
methodpublicTurn() : bool

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

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

Returns
TypeDescription
bool
Details
Access
public  
methodpublicVerify( $name) : int

Verifies that the name is recognized by the server.

Returns false if the name could not be verified otherwise the response from the server is returned.

Implements rfc 821: VRFY

SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,553 SMTP CODE ERROR : 500,501,502,421

Parameters
NameTypeDescription
$name
Returns
TypeDescription
int
Details
Access
public  
methodpublicget_lines() : string

Read in as many lines as possible either before eof or socket timeout occurs on the operation.

With SMTP we can tell if we have more lines to read if the 4th character is '-' symbol. If it is a space then we don't need to read anything else.

Returns
TypeDescription
string
Details
Access
private  
Documentation was generated by phpDocumentor 2.0.0a12.