org.apache.geronimo.javamail.store.imap.connection
Class IMAPFetchBodyPart

java.lang.Object
  org.apache.geronimo.javamail.store.imap.connection.IMAPFetchDataItem
      org.apache.geronimo.javamail.store.imap.connection.IMAPFetchBodyPart

Direct Known Subclasses:

IMAPBody, IMAPInternetHeader, IMAPMessageText

public class IMAPFetchBodyPart
extends IMAPFetchDataItem

Field Summary

protected IMAPBodySection

section

Fields inherited from class org.apache.geronimo.javamail.store.imap.connection.IMAPFetchDataItem

BODY, BODYSTRUCTURE, ENVELOPE, FETCH, FLAGS, HEADER, INTERNALDATE, SIZE, TEXT, type, UID

Constructor Summary

IMAPFetchBodyPart(int type, IMAPBodySection section)
Construct a base BODY section subpiece.

Method Summary

String	getPartNumber() Get the part number information associated with this request.
int	getSectionType() Get the section type information.
int	getSubstringLength() Returns the length of the substring section.
int	getSubstringStart() Get the substring start location.

Methods inherited from class org.apache.geronimo.javamail.store.imap.connection.IMAPFetchDataItem

getType, isType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

section

protected IMAPBodySection section

Constructor Detail

IMAPFetchBodyPart

public IMAPFetchBodyPart(int type,
                         IMAPBodySection section)

Construct a base BODY section subpiece.

Parameters:

type - The fundamental type of the body section. This will be either BODY, TEXT, or HEADER, depending on the subclass.

section - The section information. This will contain the section numbering information, the section name, and and substring information if this was a partial fetch request.

Method Detail

getPartNumber

public String getPartNumber()

Get the part number information associated with this request.

Returns:

The string form of the part number.

getSectionType

public int getSectionType()

Get the section type information. This is the qualifier that appears within the "[]" of the body sections.

Returns:

The numeric identifier for the type from the IMAPBodySection.

getSubstringStart

public int getSubstringStart()

Get the substring start location.

Returns:

The start location for the substring. Returns -1 if this is not a partial fetch.

getSubstringLength

public int getSubstringLength()

Returns the length of the substring section.

Returns:

The length of the substring section. Returns -1 if this was not a partial fetch.