org.apache.james.mailbox
Interface MimeDescriptor

All Superinterfaces:
Headers

public interface MimeDescriptor
extends Headers


Method Summary
 java.util.Map<java.lang.String,java.lang.String> contentTypeParameters()
          Gets MIME body parameters parsed from Content-Type.
 MimeDescriptor embeddedMessage()
          Gets embedded message.
 long getBodyOctets()
          The number of octets contained in the body of this part.
 java.lang.String getContentDescription()
          Gets MIME Content-Description header value.
 java.lang.String getContentID()
          Gets the MIME Content-ID header value.
 java.lang.String getContentLocation()
          Gets MIME Content-Location header value.
 java.lang.String getContentMD5()
          Gets MIME Content-MD5 header value.
 java.lang.String getDisposition()
          Gets MIME Content-Disposition.
 java.util.Map<java.lang.String,java.lang.String> getDispositionParams()
          Gets MIME Content-Disposition parameters.
 java.util.List<java.lang.String> getLanguages()
          Gets the languages, From the MIME Content-Language header value.
 long getLines()
          Gets the number of lines of text in a part of type TEXT when transfer encoded.
 java.lang.String getMimeSubType()
          Gets the MIME content subtype.
 java.lang.String getMimeType()
          Gets the top level MIME content media type.
 java.lang.String getTransferContentEncoding()
          Gets the MIME content transfer encoding.
 java.util.Iterator<MimeDescriptor> parts()
          Gets parts.
 
Methods inherited from interface org.apache.james.mailbox.Headers
headers
 

Method Detail

getMimeType

java.lang.String getMimeType()
Gets the top level MIME content media type.

Returns:
top level MIME content media type, or null if default

getMimeSubType

java.lang.String getMimeSubType()
Gets the MIME content subtype.

Returns:
the MIME content subtype, or null if default

getContentID

java.lang.String getContentID()
Gets the MIME Content-ID header value.

Returns:
MIME Content-ID, possibly null

getContentDescription

java.lang.String getContentDescription()
Gets MIME Content-Description header value.

Returns:
MIME Content-Description, possibly null

getContentLocation

java.lang.String getContentLocation()
Gets MIME Content-Location header value.

Returns:
parsed MIME Content-Location, possibly null

getContentMD5

java.lang.String getContentMD5()
Gets MIME Content-MD5 header value.

Returns:
parsed MIME Content-MD5, possibly null

getTransferContentEncoding

java.lang.String getTransferContentEncoding()
Gets the MIME content transfer encoding.

Returns:
MIME Content-Transfer-Encoding, possibly null

getLanguages

java.util.List<java.lang.String> getLanguages()
Gets the languages, From the MIME Content-Language header value.

Returns:
List of String names

getDisposition

java.lang.String getDisposition()
Gets MIME Content-Disposition.

Returns:
Content-Disposition, or null if no disposition header exists

getDispositionParams

java.util.Map<java.lang.String,java.lang.String> getDispositionParams()
Gets MIME Content-Disposition parameters.

Returns:
Content-Disposition values indexed by names

getLines

long getLines()
Gets the number of lines of text in a part of type TEXT when transfer encoded.

Returns:
CRLF count when a TEXT type, otherwise -1

getBodyOctets

long getBodyOctets()
The number of octets contained in the body of this part.

Returns:
number of octets

parts

java.util.Iterator<MimeDescriptor> parts()
Gets parts.

Returns:
MimeDescriptor Iterator when a composite top level MIME media type, null otherwise

embeddedMessage

MimeDescriptor embeddedMessage()
Gets embedded message.

Returns:
MimeDescriptor when top level MIME type is message, null otherwise

contentTypeParameters

java.util.Map<java.lang.String,java.lang.String> contentTypeParameters()
Gets MIME body parameters parsed from Content-Type.

Returns:
Header Iterator, not null


Copyright © 2002-2010 The Apache Software Foundation. All Rights Reserved.