Class Swift_Authenticator_PopB4Smtp_Pop3Connection

Description

Swift PopB4Smtp Authenticator Connection Component for the POP3 server

Provides a I/O wrapper for the POP3 connection

Located in /Swift/Authenticator/PopB4Smtp/Pop3Connection.php (line 19)


	
			
Class Constant Summary
 ENC_OFF = 0
 ENC_SSL = 1
Variable Summary
resource $handle
int $port
string $server
Method Summary
Swift_Authenticator_PopB4Smtp_Pop3Connection __construct ([string $server = "localhost"], [int $port = 110], [int $encryption = 0])
void assertOk ( $line)
int getEncryption ()
int getPort ()
string getServer ()
string read ()
void setEncryption (int $enc)
void setPort (int $port)
void setServer (string $server)
void start ()
void stop ()
void write (string $command)
Variables
resource $handle = null (line 43)

The open connection resource from fsockopen()

  • access: protected
int $port = null (line 38)

The port to connect to

  • access: protected
string $server = null (line 33)

The server to connect to (IP or FQDN)

  • access: protected
Methods
Constructor __construct (line 51)

Constructor

  • access: public
Swift_Authenticator_PopB4Smtp_Pop3Connection __construct ([string $server = "localhost"], [int $port = 110], int $encryption)
  • string $server: The name of the POP3 server
  • int $port: The port for the POP3 service
  • int $encryption: The level of encryption to use
assertOk (line 109)

Check if the response is a +OK response

  • access: public
  • throws: Swift_ConnectionException Upon bad response
void assertOk ( $line)
  • $line
getEncryption (line 101)

Get the current encryption level set (corresponds to ENC_SSL or ENC_OFF)

  • access: public
int getEncryption ()
getPort (line 85)

Get the remote port number

  • access: public
int getPort ()
getServer (line 77)

Get the server name

  • access: public
string getServer ()
read (line 154)

Return the unread buffer contents

  • access: public
  • throws: Swift_ConnectionException If the connection will not allow data to be read
string read ()
setEncryption (line 93)

Set the level of enryption to use (see ENC_OFF or ENC_SSL)

  • access: public
void setEncryption (int $enc)
  • int $enc: The constant for the encryption level
setPort (line 69)

Set the port number for the POP3 server

  • access: public
void setPort (int $port)
  • int $port
setServer (line 61)

Set the server name

  • access: public
void setServer (string $server)
  • string $server: The IP or FQDN of the POP3 server
start (line 122)

Try to open the connection

  • access: public
  • throws: Swift_ConnectionException If the connection will not start
void start ()
stop (line 137)

Try to close the connection

  • access: public
  • throws: Swift_ConnectionException If the connection won't close
void stop ()
write (line 168)

Write a command to the remote socket

  • access: public
  • throws: Swift_ConnectionException If the command cannot be written
void write (string $command)
  • string $command: the command to send (without CRLF)
Class Constants
ENC_OFF = 0 (line 24)

Constant for no encyption

ENC_SSL = 1 (line 28)

Constant for SSL encryption

Documentation generated on Wed, 26 Mar 2008 20:33:10 +1100 by phpDocumentor 1.3.1