FileDocCategorySizeDatePackage
SMTPReply.javaAPI DocApache Commons NET 1.4.1 API6703Sat Dec 03 10:05:50 GMT 2005org.apache.commons.net.smtp

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

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


    // Cannot be instantiated
     
    
Methods Summary
public static booleanisNegativePermanent(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.

param
reply The reply code to test.
return
True if a reply code is a negative permanent response, false if not.

        return (reply >= 500 && reply < 600);
    
public static booleanisNegativeTransient(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.

param
reply The reply code to test.
return
True if a reply code is a negative transient response, false if not.

        return (reply >= 400 && reply < 500);
    
public static booleanisPositiveCompletion(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.

param
reply The reply code to test.
return
True if a reply code is a postive completion response, false if not.

        return (reply >= 200 && reply < 300);
    
public static booleanisPositiveIntermediate(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.

param
reply The reply code to test.
return
True if a reply code is a postive intermediate response, false if not.

        return (reply >= 300 && reply < 400);
    
public static booleanisPositivePreliminary(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.

param
reply The reply code to test.
return
True if a reply code is a postive preliminary response, false if not.

        return (reply >= 100 && reply < 200);