Summary

Fully Qualified Name:	Zend\Mail\Protocol\Smtp\Auth\Crammd5
Extends:	Smtp

Description

Methods

Name	Description	Defined By
__construct()	Constructor.	Crammd5
__destruct()	Class destructor to cleanup open resources	AbstractProtocol
auth()	Performs CRAM-MD5 authentication with supplied credentials	Crammd5
connect()	Connect to the server with the parameters given in the constructor.	Smtp
data()	Issues DATA command	Smtp
disconnect()	Closes connection	Smtp
getLog()	Retrieve the transaction log	AbstractProtocol
getMaximumLog()	Get the maximum log size	AbstractProtocol
getPassword()	Get password	Crammd5
getRequest()	Retrieve the last client request	AbstractProtocol
getResponse()	Retrieve the last server response	AbstractProtocol
getUsername()	Get username	Crammd5
hasSession()	Returns the perceived session status	Smtp
helo()	Initiate HELO/EHLO sequence and set flag to indicate valid smtp session	Smtp
mail()	Issues MAIL command	Smtp
noop()	Issues the NOOP command end validates answer	Smtp
quit()	Issues the QUIT command and clears the current session	Smtp
rcpt()	Issues RCPT command	Smtp
resetLog()	Reset the transaction log	AbstractProtocol
rset()	Issues the RSET command end validates answer	Smtp
setMaximumLog()	Set the maximum log size	AbstractProtocol
setPassword()	Set value for password	Crammd5
setUseCompleteQuit()	Set whether or not send QUIT command	Smtp
setUsername()	Set value for username	Crammd5
useCompleteQuit()	Whether or not send QUIT command	Smtp
vrfy()	Issues the VRFY command end validates answer	Smtp

Method Details

__construct()

Constructor.

All parameters may be passed as an array to the first argument of the constructor. If so,

Parameter Name	Type	Description
$host	string|array	(Default:
$port	null|int	(Default:
$config	null|array	Auth-specific

Returns:

__destruct()

Class destructor to cleanup open resources

Returns:

auth()

Performs CRAM-MD5 authentication with supplied credentials

Returns:

connect()

Connect to the server with the parameters given in the constructor.

Returns: bool

data()

Issues DATA command

Parameter Name	Type	Description
$data	string

Returns:

disconnect()

Closes connection

Returns:

getLog()

Retrieve the transaction log

Returns: string

getMaximumLog()

Get the maximum log size

Returns: int the maximum log size

getPassword()

Get password

Returns: string

getRequest()

Retrieve the last client request

Returns: string

getResponse()

Retrieve the last server response

Returns: array

getUsername()

Get username

Returns: string

hasSession()

Returns the perceived session status

Returns: bool

helo()

Initiate HELO/EHLO sequence and set flag to indicate valid smtp session

Parameter Name	Type	Description
$host	string	The

Returns:

mail()

Issues MAIL command

Parameter Name	Type	Description
$from	string	Sender

Returns:

noop()

Issues the NOOP command end validates answer

Not used by Zend\Mail, could be used to keep a connection alive or check if it is still open.

Returns:

quit()

Issues the QUIT command and clears the current session

Returns:

rcpt()

Issues RCPT command

Parameter Name	Type	Description
$to	string	Receiver(s)

Returns:

resetLog()

Reset the transaction log

Returns:

rset()

Issues the RSET command end validates answer

Can be used to restore a clean smtp communication state when a transaction has been cancelled or commencing a new transaction.

Returns:

setMaximumLog()

Set the maximum log size

Parameter Name	Type	Description
$maximumLog	int	Maximum

Returns:

setPassword()

Set value for password

Parameter Name	Type	Description
$password	string

Returns: \Crammd5

setUseCompleteQuit()

Set whether or not send QUIT command

Parameter Name	Type	Description
$useCompleteQuit	bool	use

Returns: bool

setUsername()

Set value for username

Parameter Name	Type	Description
$username	string

Returns: \Crammd5

useCompleteQuit()

Whether or not send QUIT command

Returns: bool

vrfy()

Issues the VRFY command end validates answer

Not used by Zend\Mail.

Parameter Name	Type	Description
$user	string	User

Returns: