Referência à classe SMTP

Membros públicos
	SMTP ()
	__construct ()
	connect ($host, $port=0, $tval=30)
	authenticate ($username, $password)
	connected ()
	close ()
	data ($msg_data)
	expand ($name)
	hello ($host="")
	sendHello ($hello, $host)
	help ($keyword="")
	mail ($from)
	noop ()
	quit ($close_on_error=true)
	recipient ($to)
	reset ()
	send ($from)
	sendAndMail ($from)
	sendOrMail ($from)
	turn ()
	verify ($name)
	get_lines ()

Campos de Dados
	$SMTP_PORT = 25
	$CRLF = "\r\n"
	$do_debug
	$smtp_conn
	$error
	$helo_rply

Documentação dos Construtores & Destrutor

__construct()

__construct

(

)

Documentação das funções

authenticate()

authenticate	(		$username,
			$password )

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

Retorna

bool

close()

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. @access public

Retorna

void

connect()

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 @access public

Retorna

bool

connected()

connected

(

)

Returns true if connected to a server otherwise false @access private

Retorna

bool

data()

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 @access public

Retorna

bool

expand()

expand

(

$name

)

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: [ <full-name> <sp> ] <path> The definition of <path> is defined in rfc 821

Implements rfc 821: EXPN <SP> <string> <CRLF>

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

Retorna

string array

get_lines()

get_lines

(

)

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. @access private

Retorna

string

hello()

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 @access public

Retorna

bool

help()

help

(

$keyword = ""

)

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 [ <SP> <string> ] <CRLF>

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

Retorna

string

mail()

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 @access public

Retorna

bool

noop()

noop

(

)

Sends the command NOOP to the SMTP server.

Implements from rfc 821: NOOP <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421 @access public

Retorna

bool

quit()

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 @access public

Retorna

bool

recipient()

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 @access public

Retorna

bool

reset()

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 @access public

Retorna

bool

send()

send

(

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

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

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

Retorna

bool

sendAndMail()

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 @access public

Retorna

bool

sendHello()

sendHello	(		$hello,
			$host )

Sends a HELO/EHLO command. @access private

Retorna

bool

sendOrMail()

sendOrMail

(

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

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

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

Retorna

bool

SMTP()

SMTP

(

)

#- Initialize the class so that the data is in a known state. @access public

Retorna

void

turn()

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 @access public

Retorna

bool

verify()

verify

(

$name

)

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 <SP> <string> <CRLF>

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

Retorna

int

Documentação dos campos e atributos

$CRLF

$CRLF = "\r\n"

$do_debug

$do_debug

$error

$error

$helo_rply

$helo_rply

$smtp_conn

$smtp_conn

#+ @access private

$SMTP_PORT

$SMTP_PORT = 25

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• /var/docker/solisge-devel/www/solisge/miolo25/classes/extensions/class.smtp.php