MimeMailExceptionCode

java.lang.Object
- java.lang.Enum<MimeMailExceptionCode>
- - com.openexchange.mail.mime.MimeMailExceptionCode

All Implemented Interfaces:

com.openexchange.exception.DisplayableOXExceptionCode, com.openexchange.exception.OXExceptionCode, com.openexchange.exception.OXExceptionConstants, java.io.Serializable, java.lang.Comparable<MimeMailExceptionCode>
```
public enum MimeMailExceptionCode
extends java.lang.Enum<MimeMailExceptionCode>
implements com.openexchange.exception.DisplayableOXExceptionCode
```
For MIME related errors.
Taken from OXException:
The detail number range in subclasses generated in mail bundles is supposed to start with 2000 and may go up to 2999.
The detail number range in subclasses generated in transport bundles is supposed to start with 3000 and may go up to 3999.

Author:

Thorben Betten

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BAD_COMMAND` Mail server indicates a bad command.
`BAD_COMMAND_EXT` Bad command indicated by mail server %1$s with login %2$s (user=%3$s, context=%4$s).
`BIND_ERROR` Could not bind mail connection to local port %1$s Signals that an error occurred while attempting to bind a socket to a local address and port.
`BROKEN_CONNECTION` Connection is broken due to a socket exception on remote mail server: %1$s
`COMMAND_FAILED` A command sent to mail server failed.
`COMMAND_FAILED_EXT` A command failed on mail server %1$s with login %2$s (user=%3$s, context=%4$s).
`CONNECT_ERROR` Connection was refused or timed out while attempting to connect to remote mail server %1$s for user %2$s.
`CONNECTION_RESET` Connection was reset
`FOLDER_CLOSED` Folder "%1$s" has been closed due to some reason.
`FOLDER_CLOSED_EXT` Folder "%1$s" has been closed on mail server %2$s with login %3$s (user=%4$s, context=%5$s) due to some reason.
`FOLDER_NOT_FOUND` Mail folder "%1$s" could not be found.
`FOLDER_NOT_FOUND_EXT` Mail folder "%1$s" could not be found on mail server %2$s with login %3$s (user=%4$s, context=%5$s).
`ILLEGAL_WRITE` Illegal write attempt: %1$s The exception thrown when a write is attempted on a read-only attribute of any Messaging object.
`IN_USE_ERROR` That mailbox is already in use by another process.
`IN_USE_ERROR_EXT` That mailbox is already in use by another process on %1$s mail server for login %2$s (user=%3$s, context=%4$s).
`INVALID_CREDENTIALS` Wrong or missing login data to access mail server %1$s.
`INVALID_CREDENTIALS_EXT` Wrong or missing login data to access mail server %1$s with login %2$s (user=%3$s, context=%4$s).
`INVALID_EMAIL_ADDRESS` Invalid email address %1$s
`IO_ERROR` An I/O error occurred: %1$s
`IO_ERROR_EXT` I/O error "%1$s" occurred in communication with "%2$s" mail server for login %3$s (user=%4$s, context=%5$s).
`LOGIN_FAILED` There was an issue in authenticating your E-Mail password.
`MESSAGE_NOT_DISPLAYED` Message cannot be displayed.
`MESSAGE_REMOVED` Mail(s) could not be found in folder The exception thrown when an invalid method is invoked on an expunged Message.
`MESSAGE_TOO_LARGE` Message could not be sent because it is too large
`MESSAGING_ERROR` Messaging error: %1$s
`METHOD_NOT_SUPPORTED` Method not supported: %1$s The exception thrown when a method is not supported by the implementation
`NO_ROUTE_TO_HOST` No route to host: mail server %1$s cannot be reached Signals that an error occurred while attempting to connect to remote mail server.
`NO_SUCH_PROVIDER` Session attempts to instantiate a provider that doesn't exist: %1$s
`PARSE_ERROR` Wrong message header: %1$s The exception thrown due to an error in parsing RFC822 or MIME headers
`PORT_UNREACHABLE` Port %1$s was unreachable on remote mail server
`PROCESSING_ERROR` Error processing mail server response.
`PROCESSING_ERROR_EXT` Error processing %1$s mail server response for login %2$s (user=%3$s, context=%4$s).
`PROCESSING_ERROR_WE` Error processing mail server response.
`PROCESSING_ERROR_WE_EXT` Error processing %1$s mail server response for login %2$s (user=%3$s, context=%4$s).
`PROTOCOL_ERROR` An error in mail server protocol.
`PROTOCOL_ERROR_EXT` Protocol error in data sent to the mail server %1$s with login %2$s (user=%3$s, context=%4$s).
`QUOTA_EXCEEDED` The quota on mail server exceeded.
`QUOTA_EXCEEDED_EXT` The quota on mail server "%1$s" exceeded with login %2$s (user=%3$s, context=%4$s).
`READ_ONLY_FOLDER` An attempt was made to open a read-only folder with read-write "%1$s"
`READ_ONLY_FOLDER_EXT` An attempt was made to open a read-only folder with read-write "%1$s" on mail server %2$s with login %3$s (user=%4$s, context=%5$s)
`SEARCH_ERROR` Invalid search expression: %1$s
`SEND_FAILED` Message could not be sent to following recipients: %1$s The exception includes those addresses to which the message could not be sent as well as the valid addresses to which the message was sent and valid addresses to which the message was not sent.
`SEND_FAILED_EXT` Message could not be sent to following recipients: %1$s %2$s (arbitrary server information)
`SEND_FAILED_MSG_ERROR` Message could not be sent: %1$s
`SEND_FAILED_MSG_EXT_ERROR` Message could not be sent: %1$s %2$s (arbitrary server information)
`SOCKET_ERROR` A socket error occurred: %1$s
`STORE_CLOSED` Lost connection to mail server.
`STORE_CLOSED_EXT` Connection closed to mail server %1$s with login %2$s (user=%3$s, context=%4$s).
`TRANSPORT_INVALID_CREDENTIALS` Wrong or missing login data to access mail transport server %1$s.
`TRANSPORT_INVALID_CREDENTIALS_EXT` Wrong or missing login data to access mail transport server %1$s with login %2$s (user=%3$s, context=%4$s).
`UNKNOWN_HOST` The IP address of host "%1$s" could not be determined

Field Summary
- Fields inherited from interface com.openexchange.exception.OXExceptionConstants
  CATEGORY_CAPACITY, CATEGORY_CONFIGURATION, CATEGORY_CONFLICT, CATEGORY_CONNECTIVITY, CATEGORY_ERROR, CATEGORY_PERMISSION_DENIED, CATEGORY_SERVICE_DOWN, CATEGORY_TRUNCATED, CATEGORY_TRY_AGAIN, CATEGORY_USER_INPUT, CATEGORY_WARNING, CODE_DEFAULT, EMPTY_MSG, MESSAGE_ARGS_EMPTY, PREFIX_GENERAL, PROPERTY_AUTH_ID, PROPERTY_CLIENT, PROPERTY_CONTEXT, PROPERTY_LOCALE, PROPERTY_LOGIN, PROPERTY_REQUEST, PROPERTY_REQUEST_BODY, PROPERTY_RESPONSE, PROPERTY_SESSION, PROPERTY_USER

Method Summary

Methods
Modifier and Type	Method and Description
`com.openexchange.exception.OXException`	`create()` Creates a new `OXException` instance pre-filled with this code's attributes.
`com.openexchange.exception.OXException`	`create(java.lang.Object... args)` Creates a new `OXException` instance pre-filled with this code's attributes.
`com.openexchange.exception.OXException`	`create(java.lang.Throwable cause, java.lang.Object... args)` Creates a new `OXException` instance pre-filled with this code's attributes.
`boolean`	`equals(com.openexchange.exception.OXException e)`
`com.openexchange.exception.Category`	`getCategory()`
`java.lang.String`	`getDisplayMessage()`
`java.lang.String`	`getMessage()`
`int`	`getNumber()`
`java.lang.String`	`getPrefix()`
`static MimeMailExceptionCode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static MimeMailExceptionCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - LOGIN_FAILED
```
public static final MimeMailExceptionCode LOGIN_FAILED
```
    There was an issue in authenticating your E-Mail password. This may be because of a recent password change. To continue please logout now and then log back in with your most current password. (server=%1$s | user=%2$s)
  - INVALID_CREDENTIALS
```
public static final MimeMailExceptionCode INVALID_CREDENTIALS
```
    Wrong or missing login data to access mail server %1$s. Error message from mail server: %2$s
  - INVALID_CREDENTIALS_EXT
```
public static final MimeMailExceptionCode INVALID_CREDENTIALS_EXT
```
    Wrong or missing login data to access mail server %1$s with login %2$s (user=%3$s, context=%4$s). Error message from mail server: %5$s
  - FOLDER_NOT_FOUND
```
public static final MimeMailExceptionCode FOLDER_NOT_FOUND
```
    Mail folder "%1$s" could not be found.
  - FOLDER_NOT_FOUND_EXT
```
public static final MimeMailExceptionCode FOLDER_NOT_FOUND_EXT
```
    Mail folder "%1$s" could not be found on mail server %2$s with login %3$s (user=%4$s, context=%5$s).
  - FOLDER_CLOSED
```
public static final MimeMailExceptionCode FOLDER_CLOSED
```
    Folder "%1$s" has been closed due to some reason.
    Probably your request took too long.
    This exception is thrown when a method is invoked on a Messaging object and the Folder that owns that object has died due to some reason. Following the exception, the Folder is reset to the "closed" state.
  - FOLDER_CLOSED_EXT
```
public static final MimeMailExceptionCode FOLDER_CLOSED_EXT
```
    Folder "%1$s" has been closed on mail server %2$s with login %3$s (user=%4$s, context=%5$s) due to some reason.
    Probably your request took too long.
  - ILLEGAL_WRITE
```
public static final MimeMailExceptionCode ILLEGAL_WRITE
```
    Illegal write attempt: %1$s
    The exception thrown when a write is attempted on a read-only attribute of any Messaging object.
  - MESSAGE_REMOVED
```
public static final MimeMailExceptionCode MESSAGE_REMOVED
```
    Mail(s) could not be found in folder
    The exception thrown when an invalid method is invoked on an expunged Message. The only valid methods on an expunged Message are isExpunged() and getMessageNumber().
  - METHOD_NOT_SUPPORTED
```
public static final MimeMailExceptionCode METHOD_NOT_SUPPORTED
```
    Method not supported: %1$s
    The exception thrown when a method is not supported by the implementation
  - NO_SUCH_PROVIDER
```
public static final MimeMailExceptionCode NO_SUCH_PROVIDER
```
    Session attempts to instantiate a provider that doesn't exist: %1$s
  - INVALID_EMAIL_ADDRESS
```
public static final MimeMailExceptionCode INVALID_EMAIL_ADDRESS
```
    Invalid email address %1$s
  - PARSE_ERROR
```
public static final MimeMailExceptionCode PARSE_ERROR
```
    Wrong message header: %1$s
    The exception thrown due to an error in parsing RFC822 or MIME headers
  - READ_ONLY_FOLDER
```
public static final MimeMailExceptionCode READ_ONLY_FOLDER
```
    An attempt was made to open a read-only folder with read-write "%1$s"
  - READ_ONLY_FOLDER_EXT
```
public static final MimeMailExceptionCode READ_ONLY_FOLDER_EXT
```
    An attempt was made to open a read-only folder with read-write "%1$s" on mail server %2$s with login %3$s (user=%4$s, context=%5$s)
  - SEARCH_ERROR
```
public static final MimeMailExceptionCode SEARCH_ERROR
```
    Invalid search expression: %1$s
  - MESSAGE_TOO_LARGE
```
public static final MimeMailExceptionCode MESSAGE_TOO_LARGE
```
    Message could not be sent because it is too large
  - SEND_FAILED
```
public static final MimeMailExceptionCode SEND_FAILED
```
    Message could not be sent to following recipients: %1$s
    The exception includes those addresses to which the message could not be sent as well as the valid addresses to which the message was sent and valid addresses to which the message was not sent.
  - SEND_FAILED_EXT
```
public static final MimeMailExceptionCode SEND_FAILED_EXT
```
    Message could not be sent to following recipients: %1$s %2$s (arbitrary server information)
  - STORE_CLOSED
```
public static final MimeMailExceptionCode STORE_CLOSED
```
    Lost connection to mail server.
  - STORE_CLOSED_EXT
```
public static final MimeMailExceptionCode STORE_CLOSED_EXT
```
    Connection closed to mail server %1$s with login %2$s (user=%3$s, context=%4$s).
  - BIND_ERROR
```
public static final MimeMailExceptionCode BIND_ERROR
```
    Could not bind mail connection to local port %1$s
    Signals that an error occurred while attempting to bind a socket to a local address and port. Typically, the port is in use, or the requested local address could not be assigned.
  - CONNECT_ERROR
```
public static final MimeMailExceptionCode CONNECT_ERROR
```
    Connection was refused or timed out while attempting to connect to remote mail server %1$s for user %2$s.
    An error occurred while attempting to connect to remote mail server. Typically, the connection was refused remotely (e.g., no process is listening on the remote address/port).
  - CONNECTION_RESET
```
public static final MimeMailExceptionCode CONNECTION_RESET
```
    Connection was reset
  - NO_ROUTE_TO_HOST
```
public static final MimeMailExceptionCode NO_ROUTE_TO_HOST
```
    No route to host: mail server %1$s cannot be reached
    Signals that an error occurred while attempting to connect to remote mail server. Typically, the remote mail server cannot be reached because of an intervening firewall, or if an intermediate router is down.
  - PORT_UNREACHABLE
```
public static final MimeMailExceptionCode PORT_UNREACHABLE
```
    Port %1$s was unreachable on remote mail server
  - BROKEN_CONNECTION
```
public static final MimeMailExceptionCode BROKEN_CONNECTION
```
    Connection is broken due to a socket exception on remote mail server: %1$s
  - SOCKET_ERROR
```
public static final MimeMailExceptionCode SOCKET_ERROR
```
    A socket error occurred: %1$s
  - UNKNOWN_HOST
```
public static final MimeMailExceptionCode UNKNOWN_HOST
```
    The IP address of host "%1$s" could not be determined
  - MESSAGING_ERROR
```
public static final MimeMailExceptionCode MESSAGING_ERROR
```
    Messaging error: %1$s
  - QUOTA_EXCEEDED
```
public static final MimeMailExceptionCode QUOTA_EXCEEDED
```
    The quota on mail server exceeded. Error message: %1$s
  - QUOTA_EXCEEDED_EXT
```
public static final MimeMailExceptionCode QUOTA_EXCEEDED_EXT
```
    The quota on mail server "%1$s" exceeded with login %2$s (user=%3$s, context=%4$s). Error message: %5$s
  - COMMAND_FAILED
```
public static final MimeMailExceptionCode COMMAND_FAILED
```
    A command sent to mail server failed. Server response: %1$s
  - COMMAND_FAILED_EXT
```
public static final MimeMailExceptionCode COMMAND_FAILED_EXT
```
    A command failed on mail server %1$s with login %2$s (user=%3$s, context=%4$s). Server response: %5$s
  - BAD_COMMAND
```
public static final MimeMailExceptionCode BAD_COMMAND
```
    Mail server indicates a bad command. Server response: %1$s
  - BAD_COMMAND_EXT
```
public static final MimeMailExceptionCode BAD_COMMAND_EXT
```
    Bad command indicated by mail server %1$s with login %2$s (user=%3$s, context=%4$s). Server response: %5$s
  - PROTOCOL_ERROR
```
public static final MimeMailExceptionCode PROTOCOL_ERROR
```
    An error in mail server protocol. Error message: %1$s
  - PROTOCOL_ERROR_EXT
```
public static final MimeMailExceptionCode PROTOCOL_ERROR_EXT
```
    Protocol error in data sent to the mail server %1$s with login %2$s (user=%3$s, context=%4$s). Error message: %5$s
  - SEND_FAILED_MSG_ERROR
```
public static final MimeMailExceptionCode SEND_FAILED_MSG_ERROR
```
    Message could not be sent: %1$s
  - SEND_FAILED_MSG_EXT_ERROR
```
public static final MimeMailExceptionCode SEND_FAILED_MSG_EXT_ERROR
```
    Message could not be sent: %1$s %2$s (arbitrary server information)
  - MESSAGE_NOT_DISPLAYED
```
public static final MimeMailExceptionCode MESSAGE_NOT_DISPLAYED
```
    Message cannot be displayed.
  - TRANSPORT_INVALID_CREDENTIALS
```
public static final MimeMailExceptionCode TRANSPORT_INVALID_CREDENTIALS
```
    Wrong or missing login data to access mail transport server %1$s. Error message from mail transport server: %2$s
  - TRANSPORT_INVALID_CREDENTIALS_EXT
```
public static final MimeMailExceptionCode TRANSPORT_INVALID_CREDENTIALS_EXT
```
    Wrong or missing login data to access mail transport server %1$s with login %2$s (user=%3$s, context=%4$s). Error message from mail transport server: %5$s
  - PROCESSING_ERROR
```
public static final MimeMailExceptionCode PROCESSING_ERROR
```
    Error processing mail server response. The administrator has been informed.
  - PROCESSING_ERROR_EXT
```
public static final MimeMailExceptionCode PROCESSING_ERROR_EXT
```
    Error processing %1$s mail server response for login %2$s (user=%3$s, context=%4$s). The administrator has been informed.
  - IO_ERROR
```
public static final MimeMailExceptionCode IO_ERROR
```
    An I/O error occurred: %1$s
  - IO_ERROR_EXT
```
public static final MimeMailExceptionCode IO_ERROR_EXT
```
    I/O error "%1$s" occurred in communication with "%2$s" mail server for login %3$s (user=%4$s, context=%5$s).
  - PROCESSING_ERROR_WE
```
public static final MimeMailExceptionCode PROCESSING_ERROR_WE
```
    Error processing mail server response. The administrator has been informed. Error message: %1$s
  - PROCESSING_ERROR_WE_EXT
```
public static final MimeMailExceptionCode PROCESSING_ERROR_WE_EXT
```
    Error processing %1$s mail server response for login %2$s (user=%3$s, context=%4$s). The administrator has been informed. Error message: %5$s
  - IN_USE_ERROR
```
public static final MimeMailExceptionCode IN_USE_ERROR
```
    That mailbox is already in use by another process. Please try again later.
    Error message: %1$s
  - IN_USE_ERROR_EXT
```
public static final MimeMailExceptionCode IN_USE_ERROR_EXT
```
    That mailbox is already in use by another process on %1$s mail server for login %2$s (user=%3$s, context=%4$s). Please try again later.
    Error message: %5$s
- Method Detail
  - values
```
public static MimeMailExceptionCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MimeMailExceptionCode c : MimeMailExceptionCode.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MimeMailExceptionCode valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getPrefix
```
public java.lang.String getPrefix()
```
    Specified by:
    
    getPrefix in interface com.openexchange.exception.OXExceptionCode
  - getCategory
```
public com.openexchange.exception.Category getCategory()
```
    Specified by:
    
    getCategory in interface com.openexchange.exception.OXExceptionCode
  - getNumber
```
public int getNumber()
```
    Specified by:
    
    getNumber in interface com.openexchange.exception.OXExceptionCode
  - getMessage
```
public java.lang.String getMessage()
```
    Specified by:
    
    getMessage in interface com.openexchange.exception.OXExceptionCode
  - equals
```
public boolean equals(com.openexchange.exception.OXException e)
```
    Specified by:
    
    equals in interface com.openexchange.exception.OXExceptionCode
  - getDisplayMessage
```
public java.lang.String getDisplayMessage()
```
    Specified by:
    
    getDisplayMessage in interface com.openexchange.exception.DisplayableOXExceptionCode
  - create
```
public com.openexchange.exception.OXException create()
```
    Creates a new OXException instance pre-filled with this code's attributes.
    
    Returns:
    The newly created OXException instance
  - create
```
public com.openexchange.exception.OXException create(java.lang.Object... args)
```
    Creates a new OXException instance pre-filled with this code's attributes.
    
    Parameters:
    args - The message arguments in case of printf-style message
    
    Returns:
    The newly created OXException instance
  - create
```
public com.openexchange.exception.OXException create(java.lang.Throwable cause,
                                            java.lang.Object... args)
```
    Creates a new OXException instance pre-filled with this code's attributes.
    
    Parameters:
    cause - The optional initial cause
    args - The message arguments in case of printf-style message
    
    Returns:
    The newly created OXException instance

Enum MimeMailExceptionCode

Enum Constant Summary

Field Summary

Fields inherited from interface com.openexchange.exception.OXExceptionConstants

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LOGIN_FAILED

INVALID_CREDENTIALS

INVALID_CREDENTIALS_EXT

FOLDER_NOT_FOUND

FOLDER_NOT_FOUND_EXT

FOLDER_CLOSED

FOLDER_CLOSED_EXT

ILLEGAL_WRITE

MESSAGE_REMOVED

METHOD_NOT_SUPPORTED

NO_SUCH_PROVIDER

INVALID_EMAIL_ADDRESS

PARSE_ERROR

READ_ONLY_FOLDER

READ_ONLY_FOLDER_EXT

SEARCH_ERROR

MESSAGE_TOO_LARGE

SEND_FAILED

SEND_FAILED_EXT

STORE_CLOSED

STORE_CLOSED_EXT

BIND_ERROR

CONNECT_ERROR

CONNECTION_RESET

NO_ROUTE_TO_HOST

PORT_UNREACHABLE

BROKEN_CONNECTION

SOCKET_ERROR

UNKNOWN_HOST

MESSAGING_ERROR

QUOTA_EXCEEDED

QUOTA_EXCEEDED_EXT

COMMAND_FAILED

COMMAND_FAILED_EXT

BAD_COMMAND

BAD_COMMAND_EXT

PROTOCOL_ERROR

PROTOCOL_ERROR_EXT

SEND_FAILED_MSG_ERROR

SEND_FAILED_MSG_EXT_ERROR

MESSAGE_NOT_DISPLAYED

TRANSPORT_INVALID_CREDENTIALS

TRANSPORT_INVALID_CREDENTIALS_EXT

PROCESSING_ERROR

PROCESSING_ERROR_EXT

IO_ERROR

IO_ERROR_EXT

PROCESSING_ERROR_WE

PROCESSING_ERROR_WE_EXT

IN_USE_ERROR

IN_USE_ERROR_EXT

Method Detail

values

valueOf

getPrefix

getCategory

getNumber

getMessage

equals

getDisplayMessage

create

create

create