mireka.pop

Class Pop3Exception

Object

Throwable

Exception

mireka.pop.Pop3Exception

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CommandSyntaxException, IllegalSessionStateException, MaildropLockedException, MaildropPopException

public class Pop3Exception
extends Exception

Signals POP3 related exception and optionally includes standard POP3 response codes in addition to the human readable message.

See Also:

Standard response codes assigned by IANA, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	responseCode An extended POP3 response code.

Constructor Summary

Constructors

Constructor and Description
Pop3Exception(String responseCode, String message) Constructs a Pop3Exception with the specified response code and human readable message.

Method Summary

Modifier and Type	Method and Description
String	toResponse() Returns a complete POP3 response line corresponding to this error, which can be sent to the client.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

responseCode

@Nullable
public final String responseCode

An extended POP3 response code.

Constructor Detail

Pop3Exception

public Pop3Exception(String responseCode,
                     String message)

Constructs a Pop3Exception with the specified response code and human readable message.

Parameters:

responseCode - An extended POP3 response code, for example "IN-USE". Frequently this is null, because there are not many standardized POP3 codes, moreover they are useful only if the client program should react differently to different errors.

message - Human readable message which will be sent to the client.

Method Detail

toResponse

public String toResponse()

Returns a complete POP3 response line corresponding to this error, which can be sent to the client.

Returns:

the POP3 response line, which includes the starting -ERR characters, the optional extended response code and the human readable message.