Package org.apache.commons.net.imap
Class IMAPReply
java.lang.Object
org.apache.commons.net.imap.IMAPReply
Stores IMAP reply code constants.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The reply code indicating command rejection.static final int
The reply code indicating command continuation.private static final String
The IMAP reply String indicating command rejection.private static final String
private static final String
The IMAP reply String indicating failure of an operation.private static final String
The IMAP reply String indicating success of an operation.private static final String
private static final Pattern
static final int
The reply code indicating failure of an operation.static final int
The reply code indicating success of an operation.static final int
The reply code indicating a partial response.private static final Pattern
Tag cannot contain: + ( ) { SP CTL % * " \ ]private static final String
Guard against Polynomial regular expression used on uncontrolled data.private static final Pattern
private static final String
Guard against Polynomial regular expression used on uncontrolled data. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic int
getReplyCode
(String line) Interpret the String reply code - OK, NO, BAD - in a tagged response as an integer.private static int
getReplyCode
(String line, Pattern pattern) static int
getUntaggedReplyCode
(String line) Interpret the String reply code - OK, NO, BAD - in an untagged response as an integer.static boolean
isContinuation
(int replyCode) Tests whether the reply line is a continuation, i.e.static boolean
isContinuation
(String line) Tests whether if the reply line is a continuation, i.e.static boolean
isSuccess
(int replyCode) Tests whether whether the reply code indicates success or notstatic boolean
isUntagged
(String line) Tests whether if the reply line is untagged - e.g.static int
literalCount
(String line) Checks if the line introduces a literal, i.e.
-
Field Details
-
OK
public static final int OKThe reply code indicating success of an operation.- See Also:
-
NO
public static final int NOThe reply code indicating failure of an operation.- See Also:
-
BAD
public static final int BADThe reply code indicating command rejection.- See Also:
-
CONT
public static final int CONTThe reply code indicating command continuation.- See Also:
-
PARTIAL
public static final int PARTIALThe 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:
-
IMAP_OK
The IMAP reply String indicating success of an operation.- See Also:
-
IMAP_NO
The IMAP reply String indicating failure of an operation.- See Also:
-
IMAP_BAD
The IMAP reply String indicating command rejection.- See Also:
-
IMAP_UNTAGGED_PREFIX
- See Also:
-
IMAP_CONTINUATION_PREFIX
- See Also:
-
TAGGED_RESPONSE
Guard against Polynomial regular expression used on uncontrolled data. Don't look for more than 80 letters. Don't look for more than 80 non-whitespace. Don't look for more than 80 character.- See Also:
-
TAGGED_PATTERN
Tag cannot contain: + ( ) { SP CTL % * " \ ] -
UNTAGGED_RESPONSE
Guard against Polynomial regular expression used on uncontrolled data. Don't look for more than 80 backslashes. Don't look for more than 80 character.- See Also:
-
UNTAGGED_PATTERN
-
LITERAL_PATTERN
-
-
Constructor Details
-
IMAPReply
private IMAPReply()Cannot be instantiated.
-
-
Method Details
-
getReplyCode
Interpret the String reply code - OK, NO, BAD - in a tagged response as an integer.- Parameters:
line
- the tagged line to be checked- Returns:
OK
orNO
orBAD
orCONT
- Throws:
IOException
- if the input has an unexpected format
-
getReplyCode
- Throws:
IOException
-
getUntaggedReplyCode
Interpret the String reply code - OK, NO, BAD - in an untagged response as an integer.- Parameters:
line
- the untagged line to be checked- Returns:
OK
orNO
orBAD
orCONT
- Throws:
IOException
- if the input has an unexpected format
-
isContinuation
public static boolean isContinuation(int replyCode) Tests whether the reply line is a continuation, i.e. starts with "+"- Parameters:
replyCode
- the code to be checked- Returns:
true
if the response was a continuation
-
isContinuation
Tests whether if the reply line is a continuation, i.e. starts with "+"- Parameters:
line
- the line to be checked- Returns:
true
if the line is a continuation
-
isSuccess
public static boolean isSuccess(int replyCode) Tests whether whether the reply code indicates success or not- Parameters:
replyCode
- the code to check- Returns:
true
if the code equalsOK
-
isUntagged
Tests whether if the reply line is untagged - e.g. "* OK ..."- Parameters:
line
- to be checked- Returns:
true
if 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.
-