org.apache.commons.net.smtp

Class SMTPReply


public final class SMTPReply
extends java.lang.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.

Field Summary

static int
ACTION_ABORTED
static int
ACTION_NOT_TAKEN
static int
ACTION_OK
static int
BAD_COMMAND_SEQUENCE
static int
CODE_211
static int
CODE_214
static int
CODE_215
static int
CODE_220
static int
CODE_221
static int
CODE_250
static int
CODE_251
static int
CODE_354
static int
CODE_421
static int
CODE_450
static int
CODE_451
static int
CODE_452
static int
CODE_500
static int
CODE_501
static int
CODE_502
static int
CODE_503
static int
CODE_504
static int
CODE_550
static int
CODE_551
static int
CODE_552
static int
CODE_553
static int
CODE_554
static int
COMMAND_NOT_IMPLEMENTED
static int
COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER
static int
HELP_MESSAGE
static int
INSUFFICIENT_STORAGE
static int
MAILBOX_NAME_NOT_ALLOWED
static int
MAILBOX_UNAVAILABLE
static int
SERVICE_CLOSING_TRANSMISSION_CHANNEL
static int
SERVICE_NOT_AVAILABLE
static int
SERVICE_READY
static int
START_MAIL_INPUT
static int
STORAGE_ALLOCATION_EXCEEDED
static int
SYNTAX_ERROR_IN_ARGUMENTS
static int
SYSTEM_STATUS
static int
TRANSACTION_FAILED
static int
UNRECOGNIZED_COMMAND
static int
USER_NOT_LOCAL
static int
USER_NOT_LOCAL_WILL_FORWARD

Method Summary

static boolean
isNegativePermanent(int reply)
Determine if a reply code is a negative permanent response.
static boolean
isNegativeTransient(int reply)
Determine if a reply code is a negative transient response.
static boolean
isPositiveCompletion(int reply)
Determine if a reply code is a positive completion response.
static boolean
isPositiveIntermediate(int reply)
Determine if a reply code is a positive intermediate response.
static boolean
isPositivePreliminary(int reply)
Determine if a reply code is a positive preliminary response.

Field Details

ACTION_ABORTED

public static final int ACTION_ABORTED
Field Value:
451

ACTION_NOT_TAKEN

public static final int ACTION_NOT_TAKEN
Field Value:
450

ACTION_OK

public static final int ACTION_OK
Field Value:
250

BAD_COMMAND_SEQUENCE

public static final int BAD_COMMAND_SEQUENCE
Field Value:
503

CODE_211

public static final int CODE_211
Field Value:
211

CODE_214

public static final int CODE_214
Field Value:
214

CODE_215

public static final int CODE_215
Field Value:
215

CODE_220

public static final int CODE_220
Field Value:
220

CODE_221

public static final int CODE_221
Field Value:
221

CODE_250

public static final int CODE_250
Field Value:
250

CODE_251

public static final int CODE_251
Field Value:
251

CODE_354

public static final int CODE_354
Field Value:
354

CODE_421

public static final int CODE_421
Field Value:
421

CODE_450

public static final int CODE_450
Field Value:
450

CODE_451

public static final int CODE_451
Field Value:
451

CODE_452

public static final int CODE_452
Field Value:
452

CODE_500

public static final int CODE_500
Field Value:
500

CODE_501

public static final int CODE_501
Field Value:
501

CODE_502

public static final int CODE_502
Field Value:
502

CODE_503

public static final int CODE_503
Field Value:
503

CODE_504

public static final int CODE_504
Field Value:
504

CODE_550

public static final int CODE_550
Field Value:
550

CODE_551

public static final int CODE_551
Field Value:
551

CODE_552

public static final int CODE_552
Field Value:
552

CODE_553

public static final int CODE_553
Field Value:
553

CODE_554

public static final int CODE_554
Field Value:
554

COMMAND_NOT_IMPLEMENTED

public static final int COMMAND_NOT_IMPLEMENTED
Field Value:
502

COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER

public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER
Field Value:
504

HELP_MESSAGE

public static final int HELP_MESSAGE
Field Value:
214

INSUFFICIENT_STORAGE

public static final int INSUFFICIENT_STORAGE
Field Value:
452

MAILBOX_NAME_NOT_ALLOWED

public static final int MAILBOX_NAME_NOT_ALLOWED
Field Value:
553

MAILBOX_UNAVAILABLE

public static final int MAILBOX_UNAVAILABLE
Field Value:
550

SERVICE_CLOSING_TRANSMISSION_CHANNEL

public static final int SERVICE_CLOSING_TRANSMISSION_CHANNEL
Field Value:
221

SERVICE_NOT_AVAILABLE

public static final int SERVICE_NOT_AVAILABLE
Field Value:
421

SERVICE_READY

public static final int SERVICE_READY
Field Value:
220

START_MAIL_INPUT

public static final int START_MAIL_INPUT
Field Value:
354

STORAGE_ALLOCATION_EXCEEDED

public static final int STORAGE_ALLOCATION_EXCEEDED
Field Value:
552

SYNTAX_ERROR_IN_ARGUMENTS

public static final int SYNTAX_ERROR_IN_ARGUMENTS
Field Value:
501

SYSTEM_STATUS

public static final int SYSTEM_STATUS
Field Value:
211

TRANSACTION_FAILED

public static final int TRANSACTION_FAILED
Field Value:
554

UNRECOGNIZED_COMMAND

public static final int UNRECOGNIZED_COMMAND
Field Value:
500

USER_NOT_LOCAL

public static final int USER_NOT_LOCAL
Field Value:
551

USER_NOT_LOCAL_WILL_FORWARD

public static final int USER_NOT_LOCAL_WILL_FORWARD
Field Value:
251

Method Details

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.