panda.net.smtp.SMTPReply Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of panda-core Show documentation
Panda Core is the core module of Panda Framework, it contains commonly used utility classes similar to apache-commons.
There is a newer version: 1.8.0
package panda.net.smtp;

/***
 * 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.
 ***/

public final class SMTPReply {

	public static final int SYSTEM_STATUS = 211;
	public static final int HELP_MESSAGE = 214;
	public static final int SERVICE_READY = 220;
	public static final int SERVICE_CLOSING_TRANSMISSION_CHANNEL = 221;
	public static final int ACTION_OK = 250;
	public static final int USER_NOT_LOCAL_WILL_FORWARD = 251;
	public static final int START_MAIL_INPUT = 354;
	public static final int SERVICE_NOT_AVAILABLE = 421;
	public static final int ACTION_NOT_TAKEN = 450;
	public static final int ACTION_ABORTED = 451;
	public static final int INSUFFICIENT_STORAGE = 452;
	public static final int UNRECOGNIZED_COMMAND = 500;
	public static final int SYNTAX_ERROR_IN_ARGUMENTS = 501;
	public static final int COMMAND_NOT_IMPLEMENTED = 502;
	public static final int BAD_COMMAND_SEQUENCE = 503;
	public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER = 504;
	public static final int MAILBOX_UNAVAILABLE = 550;
	public static final int USER_NOT_LOCAL = 551;
	public static final int STORAGE_ALLOCATION_EXCEEDED = 552;
	public static final int MAILBOX_NAME_NOT_ALLOWED = 553;
	public static final int TRANSACTION_FAILED = 554;

	// Cannot be instantiated
	private SMTPReply() {
	}

	/***
	 * 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.
	 ***/
	public static boolean isPositivePreliminary(int reply) {
		return (reply >= 100 && reply < 200);
	}

	/***
	 * 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.
	 ***/
	public static boolean isPositiveCompletion(int reply) {
		return (reply >= 200 && reply < 300);
	}

	/***
	 * 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.
	 ***/
	public static boolean isPositiveIntermediate(int reply) {
		return (reply >= 300 && reply < 400);
	}

	/***
	 * 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.
	 ***/
	public static boolean isNegativeTransient(int reply) {
		return (reply >= 400 && reply < 500);
	}

	/***
	 * 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.
	 ***/
	public static boolean isNegativePermanent(int reply) {
		return (reply >= 500 && reply < 600);
	}

}