org.apache.commons.net.smtp

Class SMTPReply

public final class SMTPReply extends Object

SMTPReply stores a set of constants for SMTP reply codes. To interpret the meaning of the codes, familiarity with RFC 821 is assumed. The mnemonic constant names are transcriptions from the code descriptions of RFC 821. For those who think in terms of the actual reply code values, a set of CODE_NUM constants are provided where NUM is the numerical value of the code.

Author: Daniel F. Savarese

Field Summary
static intACTION_ABORTED
static intACTION_NOT_TAKEN
static intACTION_OK
static intBAD_COMMAND_SEQUENCE
static intCODE_211
static intCODE_214
static intCODE_215
static intCODE_220
static intCODE_221
static intCODE_250
static intCODE_251
static intCODE_354
static intCODE_421
static intCODE_450
static intCODE_451
static intCODE_452
static intCODE_500
static intCODE_501
static intCODE_502
static intCODE_503
static intCODE_504
static intCODE_550
static intCODE_551
static intCODE_552
static intCODE_553
static intCODE_554
static intCOMMAND_NOT_IMPLEMENTED
static intCOMMAND_NOT_IMPLEMENTED_FOR_PARAMETER
static intHELP_MESSAGE
static intINSUFFICIENT_STORAGE
static intMAILBOX_NAME_NOT_ALLOWED
static intMAILBOX_UNAVAILABLE
static intSERVICE_CLOSING_TRANSMISSION_CHANNEL
static intSERVICE_NOT_AVAILABLE
static intSERVICE_READY
static intSTART_MAIL_INPUT
static intSTORAGE_ALLOCATION_EXCEEDED
static intSYNTAX_ERROR_IN_ARGUMENTS
static intSYSTEM_STATUS
static intTRANSACTION_FAILED
static intUNRECOGNIZED_COMMAND
static intUSER_NOT_LOCAL
static intUSER_NOT_LOCAL_WILL_FORWARD
Method Summary
static booleanisNegativePermanent(int reply)
Determine if a reply code is a negative permanent response.
static booleanisNegativeTransient(int reply)
Determine if a reply code is a negative transient response.
static booleanisPositiveCompletion(int reply)
Determine if a reply code is a positive completion response.
static booleanisPositiveIntermediate(int reply)
Determine if a reply code is a positive intermediate response.
static booleanisPositivePreliminary(int reply)
Determine if a reply code is a positive preliminary response.

Field Detail

ACTION_ABORTED

public static final int ACTION_ABORTED

ACTION_NOT_TAKEN

public static final int ACTION_NOT_TAKEN

ACTION_OK

public static final int ACTION_OK

BAD_COMMAND_SEQUENCE

public static final int BAD_COMMAND_SEQUENCE

CODE_211

public static final int CODE_211

CODE_214

public static final int CODE_214

CODE_215

public static final int CODE_215

CODE_220

public static final int CODE_220

CODE_221

public static final int CODE_221

CODE_250

public static final int CODE_250

CODE_251

public static final int CODE_251

CODE_354

public static final int CODE_354

CODE_421

public static final int CODE_421

CODE_450

public static final int CODE_450

CODE_451

public static final int CODE_451

CODE_452

public static final int CODE_452

CODE_500

public static final int CODE_500

CODE_501

public static final int CODE_501

CODE_502

public static final int CODE_502

CODE_503

public static final int CODE_503

CODE_504

public static final int CODE_504

CODE_550

public static final int CODE_550

CODE_551

public static final int CODE_551

CODE_552

public static final int CODE_552

CODE_553

public static final int CODE_553

CODE_554

public static final int CODE_554

COMMAND_NOT_IMPLEMENTED

public static final int COMMAND_NOT_IMPLEMENTED

COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER

public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER

HELP_MESSAGE

public static final int HELP_MESSAGE

INSUFFICIENT_STORAGE

public static final int INSUFFICIENT_STORAGE

MAILBOX_NAME_NOT_ALLOWED

public static final int MAILBOX_NAME_NOT_ALLOWED

MAILBOX_UNAVAILABLE

public static final int MAILBOX_UNAVAILABLE

SERVICE_CLOSING_TRANSMISSION_CHANNEL

public static final int SERVICE_CLOSING_TRANSMISSION_CHANNEL

SERVICE_NOT_AVAILABLE

public static final int SERVICE_NOT_AVAILABLE

SERVICE_READY

public static final int SERVICE_READY

START_MAIL_INPUT

public static final int START_MAIL_INPUT

STORAGE_ALLOCATION_EXCEEDED

public static final int STORAGE_ALLOCATION_EXCEEDED

SYNTAX_ERROR_IN_ARGUMENTS

public static final int SYNTAX_ERROR_IN_ARGUMENTS

SYSTEM_STATUS

public static final int SYSTEM_STATUS

TRANSACTION_FAILED

public static final int TRANSACTION_FAILED

UNRECOGNIZED_COMMAND

public static final int UNRECOGNIZED_COMMAND

USER_NOT_LOCAL

public static final int USER_NOT_LOCAL

USER_NOT_LOCAL_WILL_FORWARD

public static final int USER_NOT_LOCAL_WILL_FORWARD

Method Detail

isNegativePermanent

public static boolean isNegativePermanent(int reply)
Determine if a reply code is a negative permanent response. All codes beginning with a 5 are negative permanent responses. The SMTP server will send a negative permanent response on the failure of a command that cannot be reattempted with success.

Parameters: reply The reply code to test.

Returns: True if a reply code is a negative permanent response, false if not.

isNegativeTransient

public static boolean isNegativeTransient(int reply)
Determine if a reply code is a negative transient response. All codes beginning with a 4 are negative transient responses. The SMTP server will send a negative transient response on the failure of a command that can be reattempted with success.

Parameters: reply The reply code to test.

Returns: True if a reply code is a negative transient response, false if not.

isPositiveCompletion

public static boolean isPositiveCompletion(int reply)
Determine if a reply code is a positive completion response. All codes beginning with a 2 are positive completion responses. The SMTP server will send a positive completion response on the final successful completion of a command.

Parameters: reply The reply code to test.

Returns: True if a reply code is a postive completion response, false if not.

isPositiveIntermediate

public static boolean isPositiveIntermediate(int reply)
Determine if a reply code is a positive intermediate response. All codes beginning with a 3 are positive intermediate responses. The SMTP server will send a positive intermediate response on the successful completion of one part of a multi-part sequence of commands. For example, after a successful DATA command, a positive intermediate response will be sent to indicate that the server is ready to receive the message data.

Parameters: reply The reply code to test.

Returns: True if a reply code is a postive intermediate response, false if not.

isPositivePreliminary

public static boolean isPositivePreliminary(int reply)
Determine if a reply code is a positive preliminary response. All codes beginning with a 1 are positive preliminary responses. Postitive preliminary responses are used to indicate tentative success. No further commands can be issued to the SMTP server after a positive preliminary response until a follow up response is received from the server.

Note: No SMTP commands defined in RFC 822 provide this type of reply.

Parameters: reply The reply code to test.

Returns: True if a reply code is a postive preliminary response, false if not.