- All Known Implementing Classes:
MailCache.POP3Request
- Enclosing class:
POP3MailBox
public static interface POP3MailBox.FetchRequest
Request for fetching email data with UIDL and header options.
Method Summary
All MethodsModifier and TypeMethodDescriptionThe buffer the fetched data is read into.booleanWhether headers alone are wanted.getUIDL()The message this request is for.voidsetHeaderOnly(boolean headerOnly) Downgrade a request from a full message to headers only, used when the server does not support the TOP command.voidsetSuccess(boolean success) Record the outcome of the fetch back to the requesting session.
Method Details
getUIDL
String getUIDL()The message this request is for.- Returns:
- the server-side unique id of the message to fetch
getHeaderOnly
boolean getHeaderOnly()Whether headers alone are wanted.- Returns:
- true if only the headers are wanted, false to retrieve the whole message
getBuffer
Buffer getBuffer()The buffer the fetched data is read into.- Returns:
- the buffer the fetched data is read into, never null
setSuccess
void setSuccess(boolean success) Record the outcome of the fetch back to the requesting session.- Parameters:
success- whether the server returned the message without error
setHeaderOnly
void setHeaderOnly(boolean headerOnly) Downgrade a request from a full message to headers only, used when the server does not support the TOP command.- Parameters:
headerOnly- true to request headers only