Package com.icegreen.greenmail.imap
Class ImapResponse
- java.lang.Object
-
- com.icegreen.greenmail.imap.ImapResponse
-
- All Implemented Interfaces:
ImapConstants
public class ImapResponse extends java.lang.Object implements ImapConstants
Class providing methods to send response messages from the server to the client.
-
-
Field Summary
-
Fields inherited from interface com.icegreen.greenmail.imap.ImapConstants
BAD, BYE, CAPABILITIES, EIGHT_BIT_ENCODING, HIERARCHY_DELIMITER, HIERARCHY_DELIMITER_CHAR, INBOX_NAME, NAMESPACE_PREFIX, NAMESPACE_PREFIX_CHAR, NO, OK, SP, UNTAGGED, USER_NAMESPACE, VERSION
-
-
Constructor Summary
Constructors Constructor Description ImapResponse(java.io.OutputStream output)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
badResponse(java.lang.String message)
Writes a standard untagged BAD response, together with a descriptive message.void
byeResponse(java.lang.String message)
void
commandComplete(ImapCommand command)
Writes a standard tagged OK response on completion of a command.void
commandComplete(ImapCommand command, java.lang.String responseCode)
Writes a standard tagged OK response on completion of a command, with a response code (eg READ-WRITE) Response is writen as:void
commandError(java.lang.String message)
Writes a standard BAD response on command error, together with a descriptive message.void
commandFailed(ImapCommand command, java.lang.String reason)
Writes a standard NO response on command failure, together with a descriptive message.void
commandFailed(ImapCommand command, java.lang.String responseCode, java.lang.String reason)
Writes a standard NO response on command failure, together with a descriptive message.void
commandResponse(ImapCommand command, java.lang.String message)
void
debugResponse(ImapSession session)
void
existsResponse(int count)
void
expungeResponse(int msn)
void
fetchResponse(int msn, java.lang.String msgData)
void
flagsResponse(javax.mail.Flags flags)
void
okResponse(java.lang.String responseCode, java.lang.String message)
Writes an untagged OK response, with the supplied response code, and an optional message.void
permanentFlagsResponse(javax.mail.Flags flags)
void
recentResponse(int count)
void
setTag(java.lang.String tag)
void
taggedResponse(java.lang.String message)
Writes the message provided to the client, prepended with the request tag.void
untaggedResponse(java.lang.String message)
Writes the message provided to the client, prepended with the untagged marker "*".
-
-
-
Method Detail
-
setTag
public void setTag(java.lang.String tag)
-
commandComplete
public void commandComplete(ImapCommand command)
Writes a standard tagged OK response on completion of a command. Response is writen as:a01 OK COMMAND_NAME completed.
- Parameters:
command
- The ImapCommand which was completed.
-
commandComplete
public void commandComplete(ImapCommand command, java.lang.String responseCode)
Writes a standard tagged OK response on completion of a command, with a response code (eg READ-WRITE) Response is writen as:a01 OK [responseCode] COMMAND_NAME completed.
- Parameters:
command
- The ImapCommand which was completed.responseCode
- A string response code to send to the client.
-
commandFailed
public void commandFailed(ImapCommand command, java.lang.String reason)
Writes a standard NO response on command failure, together with a descriptive message. Response is writen as:a01 NO COMMAND_NAME failed.
- Parameters:
command
- The ImapCommand which failed.reason
- A message describing why the command failed.
-
commandFailed
public void commandFailed(ImapCommand command, java.lang.String responseCode, java.lang.String reason)
Writes a standard NO response on command failure, together with a descriptive message. Response is writen as:a01 NO [responseCode] COMMAND_NAME failed.
- Parameters:
command
- The ImapCommand which failed.responseCode
- The Imap response code to send.reason
- A message describing why the command failed.
-
commandError
public void commandError(java.lang.String message)
Writes a standard BAD response on command error, together with a descriptive message. Response is writen as:a01 BAD
- Parameters:
message
- The descriptive error message.
-
badResponse
public void badResponse(java.lang.String message)
Writes a standard untagged BAD response, together with a descriptive message.
-
okResponse
public void okResponse(java.lang.String responseCode, java.lang.String message)
Writes an untagged OK response, with the supplied response code, and an optional message.- Parameters:
responseCode
- The response code, included in [].message
- The message to follow the []
-
flagsResponse
public void flagsResponse(javax.mail.Flags flags)
-
existsResponse
public void existsResponse(int count)
-
recentResponse
public void recentResponse(int count)
-
expungeResponse
public void expungeResponse(int msn)
-
fetchResponse
public void fetchResponse(int msn, java.lang.String msgData)
-
commandResponse
public void commandResponse(ImapCommand command, java.lang.String message)
-
taggedResponse
public void taggedResponse(java.lang.String message)
Writes the message provided to the client, prepended with the request tag.- Parameters:
message
- The message to write to the client.
-
untaggedResponse
public void untaggedResponse(java.lang.String message)
Writes the message provided to the client, prepended with the untagged marker "*".- Parameters:
message
- The message to write to the client.
-
byeResponse
public void byeResponse(java.lang.String message)
-
permanentFlagsResponse
public void permanentFlagsResponse(javax.mail.Flags flags)
-
debugResponse
public void debugResponse(ImapSession session)
-
-