Package org.apache.james.mime4j.message
Class MaximalBodyDescriptor
- java.lang.Object
-
- org.apache.james.mime4j.message.MaximalBodyDescriptor
-
- All Implemented Interfaces:
BodyDescriptor,ContentDescriptor
public class MaximalBodyDescriptor extends Object implements BodyDescriptor
ExtendedBodyDescriptorimplementation with complete content details.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetBoundary()Returns the body descriptors boundary.StringgetCharset()The body descriptors character set, defaulted appropriately for the MIME type.StringgetContentDescription()Gets the value of the RFCContent-Descriptionheader.DategetContentDispositionCreationDate()Gets thecreation-dateparameter value of thecontent-dispositionfield.StringgetContentDispositionFilename()Gets thefilenameparameter value of thecontent-dispositionfield.DategetContentDispositionModificationDate()Gets themodification-dateparameter value of thecontent-dispositionfield.Map<String,String>getContentDispositionParameters()Gets the parameters of thecontent-dispositionfield.DategetContentDispositionReadDate()Gets theread-dateparameter value of thecontent-dispositionfield.longgetContentDispositionSize()Gets thesizeparameter value of thecontent-dispositionfield.StringgetContentDispositionType()Gets the disposition type of thecontent-dispositionfield.StringgetContentId()Gets the value of the RFCContent-IDheader.List<String>getContentLanguage()Get thecontent-languageheader values.longgetContentLength()Returns the body descriptors content-length.StringgetContentLocation()Get thecontent-locationheader value.StringgetContentMD5Raw()Gets the raw, Base64 encoded value of theContent-MD5field.Map<String,String>getContentTypeParameters()StringgetMediaType()Gets the defaulted MIME media type for this content.intgetMimeMajorVersion()Gets the MIME major version as specified by theMIME-Versionheader.intgetMimeMinorVersion()Gets the MIME minor version as specified by theMIME-Versionheader.StringgetMimeType()Returns the body descriptors MIME type.StringgetSubType()Gets the defaulted MIME sub type for this content.StringgetTransferEncoding()Returns the body descriptors transfer encoding.StringtoString()
-
-
-
Method Detail
-
getMimeType
public String getMimeType()
Description copied from interface:ContentDescriptorReturns the body descriptors MIME type.- Specified by:
getMimeTypein interfaceContentDescriptor- Returns:
- The MIME type, which has been parsed from the content-type definition. Must not be null, but "text/plain", if no content-type was specified.
- See Also:
ContentDescriptor.getMediaType(),ContentDescriptor.getSubType()
-
getBoundary
public String getBoundary()
Description copied from interface:BodyDescriptorReturns the body descriptors boundary.- Specified by:
getBoundaryin interfaceBodyDescriptor- Returns:
- Boundary string, if known, or null. The latter may be the case, in particular, if the body is no multipart entity.
-
getCharset
public String getCharset()
Description copied from interface:ContentDescriptorThe body descriptors character set, defaulted appropriately for the MIME type.
For
TEXTtypes, this will be defaulted tous-ascii. For other types, when the charset parameter is missing this property will be null.- Specified by:
getCharsetin interfaceContentDescriptor- Returns:
- Character set, which has been parsed from the
content-type definition. Not null for
TEXTtypes, when unset will be set to defaultus-ascii. For other types, when unset, null will be returned.
-
getMediaType
public String getMediaType()
Description copied from interface:ContentDescriptorGets the defaulted MIME media type for this content. For exampleTEXT,IMAGE,MULTIPART- Specified by:
getMediaTypein interfaceContentDescriptor- Returns:
- the MIME media type when content-type specified,
otherwise the correct default (
TEXT) - See Also:
ContentDescriptor.getMimeType()
-
getSubType
public String getSubType()
Description copied from interface:ContentDescriptorGets the defaulted MIME sub type for this content.- Specified by:
getSubTypein interfaceContentDescriptor- Returns:
- the MIME media type when content-type is specified,
otherwise the correct default (
PLAIN) - See Also:
ContentDescriptor.getMimeType()
-
getTransferEncoding
public String getTransferEncoding()
Description copied from interface:ContentDescriptorReturns the body descriptors transfer encoding.- Specified by:
getTransferEncodingin interfaceContentDescriptor- Returns:
- The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.
-
getContentLength
public long getContentLength()
Description copied from interface:ContentDescriptorReturns the body descriptors content-length.- Specified by:
getContentLengthin interfaceContentDescriptor- Returns:
- Content length, if known, or -1, to indicate the absence of a content-length header.
-
getMimeMajorVersion
public int getMimeMajorVersion()
Gets the MIME major version as specified by theMIME-Versionheader. Defaults to one.- Returns:
- positive integer
-
getMimeMinorVersion
public int getMimeMinorVersion()
Gets the MIME minor version as specified by theMIME-Versionheader. Defaults to zero.- Returns:
- positive integer
-
getContentDescription
public String getContentDescription()
Gets the value of the RFCContent-Descriptionheader.- Returns:
- value of the
Content-Descriptionwhen present, null otherwise
-
getContentId
public String getContentId()
Gets the value of the RFCContent-IDheader.- Returns:
- value of the
Content-IDwhen present, null otherwise
-
getContentDispositionType
public String getContentDispositionType()
Gets the disposition type of thecontent-dispositionfield. The value is case insensitive and will be converted to lower case. See RFC2183.- Returns:
- content disposition type, or null when this has not been set
-
getContentDispositionParameters
public Map<String,String> getContentDispositionParameters()
Gets the parameters of thecontent-dispositionfield. See RFC2183.- Returns:
- parameter value strings indexed by parameter name strings, not null
-
getContentDispositionFilename
public String getContentDispositionFilename()
- Returns:
- filename parameter value, or null when it is not present
-
getContentDispositionModificationDate
public Date getContentDispositionModificationDate()
- Returns:
- modification-date parameter value, or null when this is not present
-
getContentDispositionCreationDate
public Date getContentDispositionCreationDate()
- Returns:
- creation-date parameter value, or null when this is not present
-
getContentDispositionReadDate
public Date getContentDispositionReadDate()
- Returns:
- read-date parameter value, or null when this is not present
-
getContentDispositionSize
public long getContentDispositionSize()
- Returns:
- size parameter value, or -1 if this size has not been set
-
getContentLanguage
public List<String> getContentLanguage()
Get thecontent-languageheader values. Each applicable language tag will be returned in order. See RFC4646 http://tools.ietf.org/html/rfc4646.- Returns:
- list of language tag Strings, or null if no header exists
-
getContentLocation
public String getContentLocation()
Get thecontent-locationheader value. See RFC2557- Returns:
- the URL content-location or null if no header exists
-
getContentMD5Raw
public String getContentMD5Raw()
Gets the raw, Base64 encoded value of theContent-MD5field. See RFC1864.- Returns:
- raw encoded content-md5 or null if no header exists
-
-