Package org.apache.commons.net.imap
Class IMAPReply
java.lang.Object
org.apache.commons.net.imap.IMAPReply
IMAPReply stores IMAP reply code constants.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe reply code indicating command rejection.static final intThe reply code indicating command continuation.static final intThe reply code indicating failure of an operation.static final intThe reply code indicating success of an operation.static final intThe reply code indicating a partial response. -
Method Summary
Modifier and TypeMethodDescriptionstatic intgetReplyCode(String line) Intepret the String reply code - OK, NO, BAD - in a tagged response as a integer.static intgetUntaggedReplyCode(String line) Intepret the String reply code - OK, NO, BAD - in an untagged response as a integer.static booleanisContinuation(int replyCode) Checks if the reply line is a continuation, i.e.static booleanisContinuation(String line) Checks if the reply line is a continuation, i.e.static booleanisSuccess(int replyCode) Checks whether the reply code indicates success or notstatic booleanisUntagged(String line) Checks if the reply line is untagged - e.g.static intliteralCount(String line) Checks if the line introduces a literal, i.e.
-
Field Details
-
OK
The reply code indicating success of an operation.- See Also:
-
NO
The reply code indicating failure of an operation.- See Also:
-
BAD
The reply code indicating command rejection.- See Also:
-
CONT
The reply code indicating command continuation.- See Also:
-
PARTIAL
The reply code indicating a partial response. This is used when a chunk listener is registered and the listener requests that the reply lines are cleared on return.- Since:
- 3.4
- See Also:
-
-
Method Details
-
getReplyCode
Intepret the String reply code - OK, NO, BAD - in a tagged response as a integer.- Parameters:
line- the tagged line to be checked- Returns:
OKorNOorBADorCONT- Throws:
IOException- if the input has an unexpected format
-
getUntaggedReplyCode
Intepret the String reply code - OK, NO, BAD - in an untagged response as a integer.- Parameters:
line- the untagged line to be checked- Returns:
OKorNOorBADorCONT- Throws:
IOException- if the input has an unexpected format
-
isContinuation
Checks if the reply line is a continuation, i.e. starts with "+"- Parameters:
replyCode- the code to be checked- Returns:
trueif the response was a continuation
-
isContinuation
Checks if the reply line is a continuation, i.e. starts with "+"- Parameters:
line- the line to be checked- Returns:
trueif the line is untagged
-
isSuccess
Checks whether the reply code indicates success or not- Parameters:
replyCode- the code to check- Returns:
trueif the code equalsOK
-
isUntagged
Checks if the reply line is untagged - e.g. "* OK ..."- Parameters:
line- to be checked- Returns:
trueif the line is untagged
-
literalCount
Checks if the line introduces a literal, i.e. ends with {dd}- Parameters:
line- the line to check- Returns:
- the literal count, or -1 if there was no literal.
-