68 Classifieds API

Features
class tree: 68Classifieds | index: 68Classifieds | all elements

Class SMTP

Description
Description | Vars (details) | Methods (details)

Located in /includes/classes/mailer/class.smtp.php (line 36) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																																																

					 
					string
					$CRLF
				

																

					 
					bool
					$do_debug
				

																

					 
					bool
					$do_verp
				

																

					 
					int
					$SMTP_PORT
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																																																																																																																																																

					 
											void
										SMTP
										()
									

																

					 
											bool
										Authenticate
											( $username,  $password)
									

																

					 
											void
										Close
										()
									

																

					 
											bool
										Connect
											( $host, [ $port = 0], [ $tval = 30])
									

																

					 
											bool
										Data
											( $msg_data)
									

																

					 
											string
										Expand
											( $name)
									

																

					 
											bool
										Hello
											([ $host = ""])
									

																

					 
											string
										Help
											([ $keyword = ""])
									

																

					 
											bool
										Mail
											( $from)
									

																

					 
											bool
										Noop
										()
									

																

					 
											bool
										Quit
											([ $close_on_error = true])
									

																

					 
											bool
										Recipient
											( $to)
									

																

					 
											bool
										Reset
										()
									

																

					 
											bool
										Send
											( $from)
									

																

					 
											bool
										SendAndMail
											( $from)
									

																

					 
											bool
										SendOrMail
											( $from)
									

																

					 
											bool
										Turn
										()
									

																

					 
											int
										Verify
											( $name)
									

											

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			 





	

		
		
			string
			$CRLF
			 =  "\r\n"			(line 48)
		
	


	

SMTP reply line ending

	
	
		
		







	

		
		
			bool
			$do_debug
						(line 54)
		
	


	

Sets whether debugging is turned on

	
	
		
		







	

		
		
			bool
			$do_verp
			 =  false			(line 60)
		
	


	

Sets VERP use on/off (default is off)

	
	
		
		







	

		
		
			int
			$SMTP_PORT
			 =  25			(line 42)
		
	


	

SMTP server port

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
														Methods (details)
						
		

		

			




	
	

		
		Constructor SMTP (line 75)
	
 
	
	

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

	
    
				
  • access: public
    • 
			

	
	

		void
		
			SMTP
		
				()
			

	
		
			
	




	
	

		
		Authenticate (line 161)
	
 
	
	

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

	
    
				
  • access: public
    • 
			

	
	

		bool
		
			Authenticate
		
					( $username,  $password)
			

	
			
    
					
  • 
				
				$username			
    • 
					
  • 
				
				$password			
    • 
				

		
			
	




	
	

		
		Close (line 249)
	
 
	
	

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
    • 
			

	
	

		void
		
			Close
		
				()
			

	
		
			
	




	
	

		
		Connect (line 100)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Connect
		
					( $host, [ $port = 0], [ $tval = 30])
			

	
			
    
					
  • 
				
				$host			
    • 
					
  • 
				
				$port			
    • 
					
  • 
				
				$tval			
    • 
				

		
			
	




	
	

		
		Data (line 282)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Data
		
					( $msg_data)
			

	
			
    
					
  • 
				
				$msg_data			
    • 
				

		
			
	




	
	

		
		Expand (line 421)
	
 
	
	

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

	
    
				
  • return: array
    • 
				
  • access: public
    • 
			

	
	

		string
		
			Expand
		
					( $name)
			

	
			
    
					
  • 
				
				$name			
    • 
				

		
			
	




	
	

		
		Hello (line 472)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Hello
		
					([ $host = ""])
			

	
			
    
					
  • 
				
				$host			
    • 
				

		
			
	




	
	

		
		Help (line 546)
	
 
	
	

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
    • 
			

	
	

		string
		
			Help
		
					([ $keyword = ""])
			

	
			
    
					
  • 
				
				$keyword			
    • 
				

		
			
	




	
	

		
		Mail (line 598)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Mail
		
					( $from)
			

	
			
    
					
  • 
				
				$from			
    • 
				

		
			
	




	
	

		
		Noop (line 641)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Noop
		
				()
			

	
		
			
	




	
	

		
		Quit (line 684)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Quit
		
					([ $close_on_error = true])
			

	
			
    
					
  • 
				
				$close_on_error			
    • 
				

		
			
	




	
	

		
		Recipient (line 738)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Recipient
		
					( $to)
			

	
			
    
					
  • 
				
				$to			
    • 
				

		
			
	




	
	

		
		Reset (line 782)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Reset
		
				()
			

	
		
			
	




	
	

		
		Send (line 831)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Send
		
					( $from)
			

	
			
    
					
  • 
				
				$from			
    • 
				

		
			
	




	
	

		
		SendAndMail (line 879)
	
 
	
	

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
    • 
			

	
	

		bool
		
			SendAndMail
		
					( $from)
			

	
			
    
					
  • 
				
				$from			
    • 
				

		
			
	




	
	

		
		SendOrMail (line 927)
	
 
	
	

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
    • 
			

	
	

		bool
		
			SendOrMail
		
					( $from)
			

	
			
    
					
  • 
				
				$from			
    • 
				

		
			
	




	
	

		
		Turn (line 972)
	
 
	
	

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
    • 
			

	
	

		bool
		
			Turn
		
				()
			

	
		
			
	




	
	

		
		Verify (line 994)
	
 
	
	

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
    • 
			

	
	

		int
		
			Verify
		
					( $name)
			

	
			
    
					
  • 
				
				$name			
    •