org.apache.james.imap.encode

Interface ImapResponseComposer

All Known Implementing Classes:

ImapResponseComposerImpl

public interface ImapResponseComposer

Method Summary

Methods

Modifier and Type	Method and Description
ImapResponseComposer	closeParen() Write a ')'
ImapResponseComposer	closeSquareBracket() Write a '}'
ImapResponseComposer	commandName(String name)
ImapResponseComposer	commandResponse(ImapCommand command, String message) Compose a response which contains the ImapCommand to which the response belongs
ImapResponseComposer	continuationResponse(String message) Writes a continuation response.
ImapResponseComposer	end() Write a CRLF and flush the composer which will write the content of it to the socket
ImapResponseComposer	flags(javax.mail.Flags flags) Compose flags to output using standard format.
ImapResponseComposer	literal(Literal literal) Compose a Literal and write it to the socket.
ImapResponseComposer	mailbox(String mailboxName) First encodes the given mailboxName using CharsetUtil.encodeModifiedUTF7(String) and then quotes the result with quote(String).
ImapResponseComposer	message(long number) Write the message of type Long
ImapResponseComposer	message(String message) Write the message of type String
ImapResponseComposer	nil() Composes a NIL.
ImapResponseComposer	openParen() Write a '('
ImapResponseComposer	openSquareBracket() Write a '{'
ImapResponseComposer	quote(String message) Write a quoted message
ImapResponseComposer	quoteUpperCaseAscii(String message) Appends the given message after conversion to upper case.
ImapResponseComposer	sequenceSet(IdRange[] ranges) Write the given sequence-set
ImapResponseComposer	skipNextSpace() Tell the ImapResponseComposer to skip the next written space
ImapResponseComposer	tag(String tag) Write a tag
ImapResponseComposer	taggedResponse(String message, String tag) Writes the message provided to the client, prepended with the request tag.
ImapResponseComposer	untagged() Write a '*'
ImapResponseComposer	untaggedNoResponse(String displayMessage, String responseCode) Writes an untagged NO response.
ImapResponseComposer	untaggedResponse(String message) Writes the message provided to the client, prepended with the untagged marker "*".
ImapResponseComposer	upperCaseAscii(String message) Appends the given message after conversion to upper case.

Method Detail

untaggedNoResponse

ImapResponseComposer untaggedNoResponse(String displayMessage,
                                      String responseCode)
                                        throws IOException

Writes an untagged NO response. Indicates that a warning. The command may still complete sucessfully.

Parameters:

displayMessage - message for display, not null

responseCode - response code or null when there is no response code

Throws:

IOException

flags

ImapResponseComposer flags(javax.mail.Flags flags)
                           throws IOException

Compose flags to output using standard format.

Parameters:

flags - Flags, not null

Throws:

IOException

nil

ImapResponseComposer nil()
                         throws IOException

Composes a NIL.

Throws:

IOException

commandResponse

ImapResponseComposer commandResponse(ImapCommand command,
                                   String message)
                                     throws IOException

Compose a response which contains the ImapCommand to which the response belongs

Parameters:

command -

message -

Returns:

self

Throws:

IOException

taggedResponse

ImapResponseComposer taggedResponse(String message,
                                  String tag)
                                    throws IOException

Writes the message provided to the client, prepended with the request tag.

Parameters:

message - The message to write to the client.

Throws:

IOException

untaggedResponse

ImapResponseComposer untaggedResponse(String message)
                                      throws IOException

Writes the message provided to the client, prepended with the untagged marker "*".

Parameters:

message - The message to write to the client.

Throws:

IOException

untagged

ImapResponseComposer untagged()
                              throws IOException

Write a '*'

Returns:

composer

Throws:

IOException

commandName

ImapResponseComposer commandName(String name)
                                 throws IOException

Parameters:

name -

Returns:

composer

Throws:

IOException

message

ImapResponseComposer message(String message)
                             throws IOException

Write the message of type String

Parameters:

message -

Returns:

composer

Throws:

IOException

message

ImapResponseComposer message(long number)
                             throws IOException

Write the message of type Long

Parameters:

number -

Returns:

composer

Throws:

IOException

mailbox

ImapResponseComposer mailbox(String mailboxName)
                             throws IOException

First encodes the given mailboxName using CharsetUtil.encodeModifiedUTF7(String) and then quotes the result with quote(String).

Parameters:

mailboxName -

Returns:

Throws:

IOException

sequenceSet

ImapResponseComposer sequenceSet(IdRange[] ranges)
                                 throws IOException

Write the given sequence-set

Parameters:

ranges -

Returns:

composer

Throws:

IOException

end

ImapResponseComposer end()
                         throws IOException

Write a CRLF and flush the composer which will write the content of it to the socket

Returns:

composer

Throws:

IOException

tag

ImapResponseComposer tag(String tag)
                         throws IOException

Write a tag

Parameters:

tag -

Returns:

composer

Throws:

IOException

quote

ImapResponseComposer quote(String message)
                           throws IOException

Write a quoted message

Parameters:

message -

Returns:

composer

Throws:

IOException

literal

ImapResponseComposer literal(Literal literal)
                             throws IOException

Compose a Literal and write it to the socket. Everything which was buffered before will get written too

Parameters:

literal -

Returns:

self

Throws:

IOException

openParen

ImapResponseComposer openParen()
                               throws IOException

Write a '('

Returns:

composer

Throws:

IOException

closeParen

ImapResponseComposer closeParen()
                                throws IOException

Write a ')'

Returns:

composer

Throws:

IOException

upperCaseAscii

ImapResponseComposer upperCaseAscii(String message)
                                    throws IOException

Appends the given message after conversion to upper case. The message may be assumed to be ASCII encoded. Conversion of characters MUST NOT be performed according to the current locale but as per ASCII.

Parameters:

message - ASCII encoded, not null

Returns:

self, not null

Throws:

IOException

quoteUpperCaseAscii

ImapResponseComposer quoteUpperCaseAscii(String message)
                                         throws IOException

Appends the given message after conversion to upper case. The message may be assumed to be ASCII encoded. Conversion of characters MUST NOT be performed according to the current locale but as per ASCII.

Parameters:

message - ASCII encoded, not null

Returns:

self, not null

Throws:

IOException

skipNextSpace

ImapResponseComposer skipNextSpace()
                                   throws IOException

Tell the ImapResponseComposer to skip the next written space

Returns:

composer

Throws:

IOException

continuationResponse

ImapResponseComposer continuationResponse(String message)
                                          throws IOException

Writes a continuation response.

Parameters:

message - message for display, not null

Throws:

IOException

closeSquareBracket

ImapResponseComposer closeSquareBracket()
                                        throws IOException

Write a '}'

Returns:

composer

Throws:

IOException

openSquareBracket

ImapResponseComposer openSquareBracket()
                                       throws IOException

Write a '{'

Returns:

composer

Throws:

IOException