Zend\Mail\Protocol\Smtp\Auth\Login
Performs LOGIN authentication
Synopsis
class Login
extends Smtp
{
- // Inherited constants from AbstractProtocol
- const EOL = "\r\n";
- const TIMEOUT_CONNECTION = 30;
- // Inherited members from Smtp
- protected string $transport;
- protected string $secure;
- protected bool $sess;
- protected bool $auth;
- protected bool $mail;
- protected bool $rcpt;
- protected bool $data;
- // Inherited members from AbstractProtocol
- protected integer $maximumLog;
- protected string $host;
- protected int $port;
- protected ValidatorChain $validHost;
- protected resource $socket;
- protected string $request;
- protected array $response;
- // methods
- public void __construct()
- public void auth()
- public Login setUsername()
- public string getUsername()
- public Login setPassword()
- public string getPassword()
- // Inherited methods from Smtp
- public void __construct()
- public bool connect()
- public void helo()
- public bool hasSession()
- protected void _ehlo()
- public void mail()
- public void rcpt()
- public void data()
- public void rset()
- public void noop()
- public void vrfy()
- public void quit()
- public void auth()
- public void disconnect()
- protected void _disconnect()
- protected void _startSession()
- protected void _stopSession()
- // Inherited methods from AbstractProtocol
- public void __construct()
- public void __destruct()
- public void setMaximumLog()
- public int getMaximumLog()
- public abstract void connect()
- public string getRequest()
- public array getResponse()
- public string getLog()
- public void resetLog()
- protected void _addLog()
- protected bool _connect()
- protected void _disconnect()
- protected int|bool _send()
- protected string _receive()
- protected string _expect()
Hierarchy
Extends
Constants
Name | Value |
---|---|
EOL | "\r\n" |
TIMEOUT_CONNECTION | 30 |
Members
protected
- $auth
—
Zend\Mail\Protocol\bool
Indicates an smtp AUTH has been issued and authenticated - $data
—
Zend\Mail\Protocol\bool
Indicates that DATA has been issued and sent - $host
—
string
Hostname or IP address of remote server - $mail
—
Zend\Mail\Protocol\bool
Indicates a MAIL command has been issued - $maximumLog
—
int
Maximum of the transaction log - $password
—
string
LOGIN password - $port
—
int
Port number of connection - $rcpt
—
Zend\Mail\Protocol\bool
Indicates one or more RCTP commands have been issued - $request
—
string
Last request sent to server - $response
—
array
Array of server responses to last request - $secure
—
string
Indicates that a session is requested to be secure - $sess
—
Zend\Mail\Protocol\bool
Indicates an smtp session has been started by the HELO command - $socket
—
resource
Socket connection resource - $transport
—
string
The transport method for the socket - $username
—
string
LOGIN username - $validHost
—
\Zend\Validator\ValidatorChain
Instance of Zend\Validator\ValidatorChain to check hostnames
Methods
public
- __construct() — Constructor.
- auth() — Perform LOGIN authentication with supplied credentials
- getPassword() — Get password
- getUsername() — Get username
- setPassword() — Set value for password
- setUsername() — Set value for username
Inherited from Zend\Mail\Protocol\Smtp
protected
- _disconnect() — Disconnect from remote host and free resource
- _ehlo() — Send EHLO or HELO depending on capabilities of smtp host
- _startSession() — Start mail session
- _stopSession() — Stop mail session
public
- auth() — Default authentication method
- connect() — Connect to the server with the parameters given in the constructor.
- data() — Issues DATA command
- disconnect() — Closes connection
- hasSession() — Returns the perceived session status
- helo() — Initiate HELO/EHLO sequence and set flag to indicate valid smtp session
- mail() — Issues MAIL command
- noop() — Issues the NOOP command end validates answer
- quit() — Issues the QUIT command and clears the current session
- rcpt() — Issues RCPT command
- rset() — Issues the RSET command end validates answer
- vrfy() — Issues the VRFY command end validates answer
Inherited from Zend\Mail\Protocol\AbstractProtocol
protected
- _addLog() — Add the transaction log
- _connect() — Connect to the server using the supplied transport and target
- _disconnect() — Disconnect from remote host and free resource
- _expect() — Parse server response for successful codes
- _receive() — Get a line from the stream.
- _send() — Send the given request followed by a LINEEND to the server.
public
- connect() — Create a connection to the remote host
- getLog() — Retrieve the transaction log
- getMaximumLog() — Get the maximum log size
- getRequest() — Retrieve the last client request
- getResponse() — Retrieve the last server response
- resetLog() — Reset the transaction log
- setMaximumLog() — Set the maximum log size