API Documentation
\

\Horde_Imap_Client_Exception_ServerResponse

Exception thrown for server error responses.

Additional server debug information MAY be found in the $details property.

Summary

Methods
Properties
Constants
__construct()
setMessage()
setCode()
messagePrintf()
__get()
$raw_msg
$command
$resp_data
$status
UNSPECIFIED
UTF7IMAP_CONVERSION
DISCONNECT
BADCHARSET
PARSEERROR
UNKNOWNCTE
BADCOMPARATOR
MBOXNOMODSEQ
SERVER_CONNECT
SERVER_READERROR
SERVER_WRITEERROR
CATENATE_BADURL
CATENATE_TOOBIG
USEATTR
NOPERM
INUSE
CORRUPTION
LIMIT
OVERQUOTA
ALREADYEXISTS
NONEXISTENT
METADATA_MAXSIZE
METADATA_TOOMANY
METADATA_NOPRIVATE
METADATA_INVALID
LOGIN_TLSFAILURE
LOGIN_NOAUTHMETHOD
LOGIN_AUTHENTICATIONFAILED
LOGIN_UNAVAILABLE
LOGIN_AUTHORIZATIONFAILED
LOGIN_EXPIRED
LOGIN_PRIVACYREQUIRED
LOGIN_SERVER_VERIFICATION_FAILED
MAILBOX_NOOPEN
MAILBOX_READONLY
POP3_TEMP_ERROR
POP3_PERM_ERROR
NOT_SUPPORTED
No protected methods found
$_pipeline
$_server
N/A
No private methods found
No private properties found
N/A

Constants

UNSPECIFIED

UNSPECIFIED

Unspecified error (DEFAULT).

UTF7IMAP_CONVERSION

UTF7IMAP_CONVERSION

There was an unrecoverable error in UTF7IMAP -> UTF8 conversion.

DISCONNECT

DISCONNECT

The server ended the connection.

BADCHARSET

BADCHARSET

The charset used in the search query is not supported on the server.

PARSEERROR

PARSEERROR

There were errors parsing the MIME/RFC 2822 header of the part.

UNKNOWNCTE

UNKNOWNCTE

The server could not decode the MIME part (see RFC 3516).

BADCOMPARATOR

BADCOMPARATOR

The comparator specified by setComparator() was not recognized by the IMAP server

MBOXNOMODSEQ

MBOXNOMODSEQ

RFC 7162 [3.1.2.2] - All mailboxes are not required to support mod-sequences.

SERVER_CONNECT

SERVER_CONNECT

Thrown if server denies the network connection.

SERVER_READERROR

SERVER_READERROR

Thrown if read error for server response.

SERVER_WRITEERROR

SERVER_WRITEERROR

Thrown if write error in server interaction.

CATENATE_BADURL

CATENATE_BADURL

Thrown on CATENATE if the URL is invalid.

CATENATE_TOOBIG

CATENATE_TOOBIG

Thrown on CATENATE if the message was too big.

USEATTR

USEATTR

Thrown on CREATE if special-use attribute is not supported.

NOPERM

NOPERM

The user did not have permissions to carry out the operation.

INUSE

INUSE

The operation was not successful because another user is holding a necessary resource. The operation may succeed if attempted later.

CORRUPTION

CORRUPTION

The operation failed because data on the server was corrupt.

LIMIT

LIMIT

The operation failed because it exceeded some limit on the server.

OVERQUOTA

OVERQUOTA

The operation failed because the user is over their quota.

ALREADYEXISTS

ALREADYEXISTS

The operation failed because the requested creation object already exists.

NONEXISTENT

NONEXISTENT

The operation failed because the requested deletion object did not exist.

METADATA_MAXSIZE

METADATA_MAXSIZE

Setting metadata failed because the size of its value is too large.

The maximum octet count the server is willing to accept will be in the exception message string.

METADATA_TOOMANY

METADATA_TOOMANY

Setting metadata failed because the maximum number of allowed annotations has already been reached.

METADATA_NOPRIVATE

METADATA_NOPRIVATE

Setting metadata failed because the server does not support private annotations on one of the specified mailboxes.

METADATA_INVALID

METADATA_INVALID

Invalid metadata entry.

LOGIN_TLSFAILURE

LOGIN_TLSFAILURE

Could not start mandatory TLS connection.

LOGIN_NOAUTHMETHOD

LOGIN_NOAUTHMETHOD

Could not find an available authentication method.

LOGIN_AUTHENTICATIONFAILED

LOGIN_AUTHENTICATIONFAILED

Generic authentication failure.

LOGIN_UNAVAILABLE

LOGIN_UNAVAILABLE

Remote server is unavailable.

LOGIN_AUTHORIZATIONFAILED

LOGIN_AUTHORIZATIONFAILED

Authentication succeeded, but authorization failed.

LOGIN_EXPIRED

LOGIN_EXPIRED

Authentication is no longer permitted with this passphrase.

LOGIN_PRIVACYREQUIRED

LOGIN_PRIVACYREQUIRED

Login requires privacy.

LOGIN_SERVER_VERIFICATION_FAILED

LOGIN_SERVER_VERIFICATION_FAILED

Server verification failed (SCRAM authentication).

MAILBOX_NOOPEN

MAILBOX_NOOPEN

Could not open/access mailbox

MAILBOX_READONLY

MAILBOX_READONLY

Could not complete the command because the mailbox is read-only

POP3_TEMP_ERROR

POP3_TEMP_ERROR

Temporary issue. Generally, there is no need to alarm the user for errors of this type.

POP3_PERM_ERROR

POP3_PERM_ERROR

Permanent error indicated by server.

NOT_SUPPORTED

NOT_SUPPORTED

Function/feature is not supported on this server.

Properties

$raw_msg

$raw_msg : string

Raw error message (in English).

Type

string

$command

$command : string

The command that caused the BAD/NO error status.

Type

string

$resp_data

$resp_data : array

The response data array.

Type

array

$status

$status : integer

Server error status.

Type

integer

Methods

setMessage()

setMessage(string  $msg)

Allow the error message to be altered.

Parameters

string $msg

Error message.

setCode()

setCode(integer  $code)

Allow the error code to be altered.

Parameters

integer $code

Error code.

messagePrintf()

messagePrintf(array  $args = array())

Perform substitution of variables in the error message.

Needed to allow for correct translation of error message.

Parameters

array $args

Arguments used for substitution.

__get()

__get(  $name)

Parameters

$name