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

Class: Net_LMTP

Source Location: /Net_LMTP-1.0.2/Net/LMTP.php

Class Overview


Provides an implementation of the LMTP protocol using PEAR's Net_Socket:: class.


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 33]
Provides an implementation of the LMTP protocol using PEAR's Net_Socket:: class.


[ Top ]


Class Variables

$supportedAuthMethods = array('DIGEST-MD5', 'CRAM-MD5', 'LOGIN')

[line 94]

The auth methods this class support

Type:   array


[ Top ]

$supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5')

[line 101]

The auth methods this class support

Type:   array


[ Top ]



Method Detail

Net_LMTP (Constructor)   [line 117]

Net_LMTP Net_LMTP( [string $host = 'localhost'], [int $port = 2003], [string $localhost = 'localhost'])

Instantiates a new Net_LMTP object, overriding any defaults with parameters that are passed in.
  • Since: 1.0
  • Access: public

Parameters:

string   $host     The server to connect to.
int   $port     The port to connect to.
string   $localhost     The value to give when sending LHLO.

[ Top ]

auth   [line 397]

mixed auth( string $uid, string $pwd, [string $method = ''])

Attempt to do LMTP authentication.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

Parameters:

string   $uid     The userid to authenticate as.
string   $pwd     The password to authenticate with.
string   $method     The requested authentication method. If none is specified, the best supported method will be used.

[ Top ]

connect   [line 287]

mixed connect( [int $timeout = null])

Attempt to connect to the LMTP server.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

Parameters:

int   $timeout     The timeout value (in seconds) for the socket connection.

[ Top ]

data   [line 675]

mixed data( string $data)

Send the DATA command.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

Parameters:

string   $data     The message body to send.

[ Top ]

disconnect   [line 314]

mixed disconnect( )

Attempt to disconnect from the LMTP server.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

[ Top ]

getResponse   [line 271]

array getResponse( )

Return a 2-tuple containing the last response from the LMTP server.
  • Return: A two-element array: the first element contains the response code as an integer and the second element contains the response's arguments as a string.
  • Since: 1.0
  • Access: public

[ Top ]

mailFrom   [line 631]

mixed mailFrom( string $sender)

Send the MAIL FROM: command.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

Parameters:

string   $sender     The sender (reverse path) to set.

[ Top ]

noop   [line 743]

mixed noop( )

Send the NOOP command.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

[ Top ]

rcptTo   [line 653]

mixed rcptTo( string $recipient)

Send the RCPT TO: command.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

Parameters:

string   $recipient     The recipient (forward path) to add.

[ Top ]

rset   [line 724]

mixed rset( )

Send the RSET command.
  • Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
  • Since: 1.0
  • Access: public

[ Top ]

setDebug   [line 142]

void setDebug( boolean $debug)

Set the value of the debugging flag.
  • Since: 1.0
  • Access: public

Parameters:

boolean   $debug     New value for the debugging flag.

[ Top ]


Documentation generated on Wed, 30 Nov 2011 13:02:39 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.