Horde_Imap_Client_Interaction_Server
in package
An object representing an IMAP server command interaction (RFC 3501 [2.2.2]).
Tags
Table of Contents
- BAD = 1
- Response codes (RFC 3501 [7.1]).
- BYE = 2
- NO = 3
- OK = 4
- PREAUTH = 5
- $responseCode : object
- Response code (RFC 3501 [7.1]). Properties: - code: (string) Response code.
- $status : string
- Status response from the server.
- $token : Horde_Imap_Client_Tokenize
- IMAP server data.
- $_checkStatus : bool
- Check for status response?
- __construct() : mixed
- Constructor.
- __toString() : mixed
- create() : Horde_Imap_Client_Interaction_Server
- Auto-scan an incoming line to determine the response type.
Constants
BAD
Response codes (RFC 3501 [7.1]).
public
mixed
BAD
= 1
BYE
public
mixed
BYE
= 2
NO
public
mixed
NO
= 3
OK
public
mixed
OK
= 4
PREAUTH
public
mixed
PREAUTH
= 5
Properties
$responseCode
Response code (RFC 3501 [7.1]). Properties: - code: (string) Response code.
public
object
$responseCode
= \null
- data: (array) Data associated with response.
$status
Status response from the server.
public
string
$status
= \null
$token
IMAP server data.
public
Horde_Imap_Client_Tokenize
$token
$_checkStatus
Check for status response?
protected
bool
$_checkStatus
= \true
Methods
__construct()
Constructor.
public
__construct(Horde_Imap_Client_Tokenize $token) : mixed
Parameters
- $token : Horde_Imap_Client_Tokenize
-
Tokenized data returned from the server.
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —create()
Auto-scan an incoming line to determine the response type.
public
static create(Horde_Imap_Client_Tokenize $t) : Horde_Imap_Client_Interaction_Server
Parameters
- $t : Horde_Imap_Client_Tokenize
-
Tokenized data returned from the server.
Return values
Horde_Imap_Client_Interaction_Server —A server response object.