Documentation

Horde_Imap_Client_Exception_ServerResponse extends Horde_Imap_Client_Exception
in package

Exception thrown for server error responses.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

ALREADYEXISTS  = 22
The operation failed because the requested creation object already exists.
BADCHARSET  = 5
The charset used in the search query is not supported on the server.
BADCOMPARATOR  = 9
The comparator specified by setComparator() was not recognized by the IMAP server
CATENATE_BADURL  = 13
Thrown on CATENATE if the URL is invalid.
CATENATE_TOOBIG  = 14
Thrown on CATENATE if the message was too big.
CORRUPTION  = 19
The operation failed because data on the server was corrupt.
DISCONNECT  = 4
The server ended the connection.
INUSE  = 18
The operation was not successful because another user is holding a necessary resource. The operation may succeed if attempted later.
LIMIT  = 20
The operation failed because it exceeded some limit on the server.
LOGIN_AUTHENTICATIONFAILED  = 102
Generic authentication failure.
LOGIN_AUTHORIZATIONFAILED  = 104
Authentication succeeded, but authorization failed.
LOGIN_EXPIRED  = 105
Authentication is no longer permitted with this passphrase.
LOGIN_NOAUTHMETHOD  = 101
Could not find an available authentication method.
LOGIN_PRIVACYREQUIRED  = 106
Login requires privacy.
LOGIN_SERVER_VERIFICATION_FAILED  = 107
Server verification failed (SCRAM authentication).
LOGIN_TLSFAILURE  = 100
Could not start mandatory TLS connection.
LOGIN_UNAVAILABLE  = 103
Remote server is unavailable.
MAILBOX_NOOPEN  = 200
Could not open/access mailbox
MAILBOX_READONLY  = 201
Could not complete the command because the mailbox is read-only
MBOXNOMODSEQ  = 10
RFC 7162 [3.1.2.2] - All mailboxes are not required to support mod-sequences.
METADATA_INVALID  = 27
Invalid metadata entry.
METADATA_MAXSIZE  = 24
Setting metadata failed because the size of its value is too large.
METADATA_NOPRIVATE  = 26
Setting metadata failed because the server does not support private annotations on one of the specified mailboxes.
METADATA_TOOMANY  = 25
Setting metadata failed because the maximum number of allowed annotations has already been reached.
NONEXISTENT  = 23
The operation failed because the requested deletion object did not exist.
NOPERM  = 17
The user did not have permissions to carry out the operation.
NOT_SUPPORTED  = 400
Function/feature is not supported on this server.
OVERQUOTA  = 21
The operation failed because the user is over their quota.
PARSEERROR  = 6
There were errors parsing the MIME/RFC 2822 header of the part.
POP3_PERM_ERROR  = 301
Permanent error indicated by server.
POP3_TEMP_ERROR  = 300
Temporary issue. Generally, there is no need to alarm the user for errors of this type.
SERVER_CONNECT  = 11
Thrown if server denies the network connection.
SERVER_READERROR  = 12
Thrown if read error for server response.
SERVER_WRITEERROR  = 16
Thrown if write error in server interaction.
UNKNOWNCTE  = 7
The server could not decode the MIME part (see RFC 3516).
UNSPECIFIED  = 0
Unspecified error (DEFAULT).
USEATTR  = 15
Thrown on CREATE if special-use attribute is not supported.
UTF7IMAP_CONVERSION  = 3
There was an unrecoverable error in UTF7IMAP -> UTF8 conversion.
$command  : string
$raw_msg  : string
Raw error message (in English).
$resp_data  : array<string|int, mixed>
$status  : int
$_pipeline  : Horde_Imap_Client_Interaction_Pipeline
Pipeline object.
$_server  : Horde_Imap_Client_Interaction_Server
Server response object.
__construct()  : mixed
Constructor.
__get()  : mixed
messagePrintf()  : mixed
Perform substitution of variables in the error message.
setCode()  : mixed
Allow the error code to be altered.
setMessage()  : mixed
Allow the error message to be altered.

Constants

ALREADYEXISTS

The operation failed because the requested creation object already exists.

public mixed ALREADYEXISTS = 22

BADCHARSET

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

public mixed BADCHARSET = 5

BADCOMPARATOR

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

public mixed BADCOMPARATOR = 9

CATENATE_BADURL

Thrown on CATENATE if the URL is invalid.

public mixed CATENATE_BADURL = 13

CATENATE_TOOBIG

Thrown on CATENATE if the message was too big.

public mixed CATENATE_TOOBIG = 14

CORRUPTION

The operation failed because data on the server was corrupt.

public mixed CORRUPTION = 19

DISCONNECT

The server ended the connection.

public mixed DISCONNECT = 4

INUSE

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

public mixed INUSE = 18

LIMIT

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

public mixed LIMIT = 20

LOGIN_AUTHENTICATIONFAILED

Generic authentication failure.

public mixed LOGIN_AUTHENTICATIONFAILED = 102

LOGIN_AUTHORIZATIONFAILED

Authentication succeeded, but authorization failed.

public mixed LOGIN_AUTHORIZATIONFAILED = 104

LOGIN_EXPIRED

Authentication is no longer permitted with this passphrase.

public mixed LOGIN_EXPIRED = 105

LOGIN_NOAUTHMETHOD

Could not find an available authentication method.

public mixed LOGIN_NOAUTHMETHOD = 101

LOGIN_PRIVACYREQUIRED

Login requires privacy.

public mixed LOGIN_PRIVACYREQUIRED = 106

LOGIN_SERVER_VERIFICATION_FAILED

Server verification failed (SCRAM authentication).

public mixed LOGIN_SERVER_VERIFICATION_FAILED = 107

LOGIN_TLSFAILURE

Could not start mandatory TLS connection.

public mixed LOGIN_TLSFAILURE = 100

LOGIN_UNAVAILABLE

Remote server is unavailable.

public mixed LOGIN_UNAVAILABLE = 103

MAILBOX_NOOPEN

Could not open/access mailbox

public mixed MAILBOX_NOOPEN = 200

MAILBOX_READONLY

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

public mixed MAILBOX_READONLY = 201

MBOXNOMODSEQ

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

public mixed MBOXNOMODSEQ = 10

METADATA_INVALID

Invalid metadata entry.

public mixed METADATA_INVALID = 27

METADATA_MAXSIZE

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

public mixed METADATA_MAXSIZE = 24

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

METADATA_NOPRIVATE

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

public mixed METADATA_NOPRIVATE = 26

METADATA_TOOMANY

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

public mixed METADATA_TOOMANY = 25

NONEXISTENT

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

public mixed NONEXISTENT = 23

NOPERM

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

public mixed NOPERM = 17

NOT_SUPPORTED

Function/feature is not supported on this server.

public mixed NOT_SUPPORTED = 400

OVERQUOTA

The operation failed because the user is over their quota.

public mixed OVERQUOTA = 21

PARSEERROR

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

public mixed PARSEERROR = 6

POP3_PERM_ERROR

Permanent error indicated by server.

public mixed POP3_PERM_ERROR = 301

POP3_TEMP_ERROR

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

public mixed POP3_TEMP_ERROR = 300

SERVER_CONNECT

Thrown if server denies the network connection.

public mixed SERVER_CONNECT = 11

SERVER_READERROR

Thrown if read error for server response.

public mixed SERVER_READERROR = 12

SERVER_WRITEERROR

Thrown if write error in server interaction.

public mixed SERVER_WRITEERROR = 16

UNKNOWNCTE

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

public mixed UNKNOWNCTE = 7

UNSPECIFIED

Unspecified error (DEFAULT).

public mixed UNSPECIFIED = 0

USEATTR

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

public mixed USEATTR = 15

UTF7IMAP_CONVERSION

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

public mixed UTF7IMAP_CONVERSION = 3

Properties

$command read-only

public string $command

The command that caused the BAD/NO error status.

$raw_msg

Raw error message (in English).

public string $raw_msg = ''
Tags
since
2.18.0

$resp_data read-only

public array<string|int, mixed> $resp_data

The response data array.

Methods

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

messagePrintf()

Perform substitution of variables in the error message.

public messagePrintf([array<string|int, mixed> $args = array() ]) : mixed

Needed to allow for correct translation of error message.

Parameters
$args : array<string|int, mixed> = array()

Arguments used for substitution.

Tags
since
2.22.0
Return values
mixed

setCode()

Allow the error code to be altered.

public setCode(int $code) : mixed
Parameters
$code : int

Error code.

Return values
mixed

setMessage()

Allow the error message to be altered.

public setMessage(string $msg) : mixed
Parameters
$msg : string

Error message.

Return values
mixed

Search results