001 /*
002 * Copyright 2001-2005 The Apache Software Foundation
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.apache.commons.net.smtp;
017
018 /***
019 * SMTPReply stores a set of constants for SMTP reply codes. To interpret
020 * the meaning of the codes, familiarity with RFC 821 is assumed.
021 * The mnemonic constant names are transcriptions from the code descriptions
022 * of RFC 821. For those who think in terms of the actual reply code values,
023 * a set of CODE_NUM constants are provided where NUM is the numerical value
024 * of the code.
025 * <p>
026 * <p>
027 * @author Daniel F. Savarese
028 ***/
029
030 public final class SMTPReply
031 {
032
033 public static final int CODE_211 = 211;
034 public static final int CODE_214 = 214;
035 public static final int CODE_215 = 215;
036 public static final int CODE_220 = 220;
037 public static final int CODE_221 = 221;
038 public static final int CODE_250 = 250;
039 public static final int CODE_251 = 251;
040 public static final int CODE_354 = 354;
041 public static final int CODE_421 = 421;
042 public static final int CODE_450 = 450;
043 public static final int CODE_451 = 451;
044 public static final int CODE_452 = 452;
045 public static final int CODE_500 = 500;
046 public static final int CODE_501 = 501;
047 public static final int CODE_502 = 502;
048 public static final int CODE_503 = 503;
049 public static final int CODE_504 = 504;
050 public static final int CODE_550 = 550;
051 public static final int CODE_551 = 551;
052 public static final int CODE_552 = 552;
053 public static final int CODE_553 = 553;
054 public static final int CODE_554 = 554;
055
056 public static final int SYSTEM_STATUS = CODE_211;
057 public static final int HELP_MESSAGE = CODE_214;
058 public static final int SERVICE_READY = CODE_220;
059 public static final int SERVICE_CLOSING_TRANSMISSION_CHANNEL = CODE_221;
060 public static final int ACTION_OK = CODE_250;
061 public static final int USER_NOT_LOCAL_WILL_FORWARD = CODE_251;
062 public static final int START_MAIL_INPUT = CODE_354;
063 public static final int SERVICE_NOT_AVAILABLE = CODE_421;
064 public static final int ACTION_NOT_TAKEN = CODE_450;
065 public static final int ACTION_ABORTED = CODE_451;
066 public static final int INSUFFICIENT_STORAGE = CODE_452;
067 public static final int UNRECOGNIZED_COMMAND = CODE_500;
068 public static final int SYNTAX_ERROR_IN_ARGUMENTS = CODE_501;
069 public static final int COMMAND_NOT_IMPLEMENTED = CODE_502;
070 public static final int BAD_COMMAND_SEQUENCE = CODE_503;
071 public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER = CODE_504;
072 public static final int MAILBOX_UNAVAILABLE = CODE_550;
073 public static final int USER_NOT_LOCAL = CODE_551;
074 public static final int STORAGE_ALLOCATION_EXCEEDED = CODE_552;
075 public static final int MAILBOX_NAME_NOT_ALLOWED = CODE_553;
076 public static final int TRANSACTION_FAILED = CODE_554;
077
078 // Cannot be instantiated
079 private SMTPReply()
080 {}
081
082 /***
083 * Determine if a reply code is a positive preliminary response. All
084 * codes beginning with a 1 are positive preliminary responses.
085 * Postitive preliminary responses are used to indicate tentative success.
086 * No further commands can be issued to the SMTP server after a positive
087 * preliminary response until a follow up response is received from the
088 * server.
089 * <p>
090 * <b> Note: </b> <em> No SMTP commands defined in RFC 822 provide this
091 * type of reply. </em>
092 * <p>
093 * @param reply The reply code to test.
094 * @return True if a reply code is a postive preliminary response, false
095 * if not.
096 ***/
097 public static boolean isPositivePreliminary(int reply)
098 {
099 return (reply >= 100 && reply < 200);
100 }
101
102 /***
103 * Determine if a reply code is a positive completion response. All
104 * codes beginning with a 2 are positive completion responses.
105 * The SMTP server will send a positive completion response on the final
106 * successful completion of a command.
107 * <p>
108 * @param reply The reply code to test.
109 * @return True if a reply code is a postive completion response, false
110 * if not.
111 ***/
112 public static boolean isPositiveCompletion(int reply)
113 {
114 return (reply >= 200 && reply < 300);
115 }
116
117 /***
118 * Determine if a reply code is a positive intermediate response. All
119 * codes beginning with a 3 are positive intermediate responses.
120 * The SMTP server will send a positive intermediate response on the
121 * successful completion of one part of a multi-part sequence of
122 * commands. For example, after a successful DATA command, a positive
123 * intermediate response will be sent to indicate that the server is
124 * ready to receive the message data.
125 * <p>
126 * @param reply The reply code to test.
127 * @return True if a reply code is a postive intermediate response, false
128 * if not.
129 ***/
130 public static boolean isPositiveIntermediate(int reply)
131 {
132 return (reply >= 300 && reply < 400);
133 }
134
135 /***
136 * Determine if a reply code is a negative transient response. All
137 * codes beginning with a 4 are negative transient responses.
138 * The SMTP server will send a negative transient response on the
139 * failure of a command that can be reattempted with success.
140 * <p>
141 * @param reply The reply code to test.
142 * @return True if a reply code is a negative transient response, false
143 * if not.
144 ***/
145 public static boolean isNegativeTransient(int reply)
146 {
147 return (reply >= 400 && reply < 500);
148 }
149
150 /***
151 * Determine if a reply code is a negative permanent response. All
152 * codes beginning with a 5 are negative permanent responses.
153 * The SMTP server will send a negative permanent response on the
154 * failure of a command that cannot be reattempted with success.
155 * <p>
156 * @param reply The reply code to test.
157 * @return True if a reply code is a negative permanent response, false
158 * if not.
159 ***/
160 public static boolean isNegativePermanent(int reply)
161 {
162 return (reply >= 500 && reply < 600);
163 }
164
165 }