org.apache.james.imap.message.response

Interface FetchResponse.Structure

Enclosing class:

FetchResponse

public static interface FetchResponse.Structure

Describes the message structure.

Method Summary

Methods

Modifier and Type	Method and Description
FetchResponse.Structure	getBody() Gets the envelope of an embedded mail.
String	getDescription() Gets Content-Description.
String	getDisposition() Gets header field-value from Content-Disposition.
Map<String,String>	getDispositionParams() Gets header field-value from Content-Disposition.
String	getEncoding() Gets content transfer encoding.
FetchResponse.Envelope	getEnvelope() Gets the envelope of an embedded mail.
String	getId() Gets Content-ID.
List<String>	getLanguages() Gets MIME Content-Language's.
long	getLines() Gets the number of lines fo transfer encoding for a TEXT type.
String	getLocation() Gets Content-Location.
String	getMD5() Gets Content-MD5.
String	getMediaType() Gets the MIME media type.
long	getOctets() Gets the size of message body the in octets.
List<String>	getParameters() Gets body type parameters.
String	getSubType() Gets the MIME content subtype
Iterator<FetchResponse.Structure>	parts() Iterates parts of a composite media type.

Method Detail

getMediaType

String getMediaType()

Gets the MIME media type.

Returns:

media type, or null if default

getSubType

String getSubType()

Gets the MIME content subtype

Returns:

subtype of null if default

getParameters

List<String> getParameters()

Gets body type parameters.

Returns:

parameters, or null

getId

String getId()

Gets Content-ID.

Returns:

MIME content ID, possibly null

getDescription

String getDescription()

Gets Content-Description.

Returns:

MIME Content-Description, possibly null

getEncoding

String getEncoding()

Gets content transfer encoding.

Returns:

MIME Content-Transfer-Encoding, possibly null

getOctets

long getOctets()

Gets the size of message body the in octets.

Returns:

number of octets in the message.

getLines

long getLines()

Gets the number of lines fo transfer encoding for a TEXT type.

Returns:

number of lines when TEXT, -1 otherwise

getMD5

String getMD5()

Gets Content-MD5.

Returns:

Content-MD5 or null if BODY FETCH or not present

getDispositionParams

Map<String,String> getDispositionParams()

Gets header field-value from Content-Disposition.

Returns:

map of field value String indexed by field name String or null if BODY FETCH or not present

getDisposition

String getDisposition()

Gets header field-value from Content-Disposition.

Returns:

disposition or null if BODY FETCH or not present

getLanguages

List<String> getLanguages()

Gets MIME Content-Language's.

Returns:

List of Content-Language name String's possibly null or null when BODY FETCH

getLocation

String getLocation()

Gets Content-Location.

Returns:

Content-Location possibly null; or null when BODY FETCH

parts

Iterator<FetchResponse.Structure> parts()

Iterates parts of a composite media type.

Returns:

Structure Iterator when composite type, null otherwise

getEnvelope

FetchResponse.Envelope getEnvelope()

Gets the envelope of an embedded mail.

Returns:

Envelope when message/rfc822 otherwise null

getBody

FetchResponse.Structure getBody()

Gets the envelope of an embedded mail.

Returns:

Structure when when message/rfc822 otherwise null