|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.james.mime4j.descriptor.DefaultBodyDescriptor
org.apache.james.mime4j.descriptor.MaximalBodyDescriptor
public class MaximalBodyDescriptor
Parses and stores values for standard MIME header values.
Constructor Summary | |
---|---|
protected |
MaximalBodyDescriptor()
|
|
MaximalBodyDescriptor(BodyDescriptor parent)
|
Method Summary | |
---|---|
void |
addField(java.lang.String name,
java.lang.String value)
Should be called for each Content- header field of
a MIME message or part. |
java.lang.String |
getContentDescription()
Gets the value of the RFC Content-Description header. |
DateTime |
getContentDispositionCreationDate()
Gets the creation-date parameter value of the content-disposition field. |
MimeException |
getContentDispositionCreationDateParseException()
Gets any exception thrown during the parsing of #getContentCreationModificationDate() |
java.lang.String |
getContentDispositionFilename()
Gets the filename parameter value of the content-disposition field. |
DateTime |
getContentDispositionModificationDate()
Gets the modification-date parameter value of the content-disposition field. |
MimeException |
getContentDispositionModificationDateParseException()
Gets any exception thrown during the parsing of RFC2183ContentDispositionDescriptor.getContentDispositionModificationDate() |
java.util.Map |
getContentDispositionParameters()
Gets the parameters of the content-disposition field. |
DateTime |
getContentDispositionReadDate()
Gets the read-date parameter value of the content-disposition field. |
MimeException |
getContentDispositionReadDateParseException()
Gets any exception thrown during the parsing of #getContentReadModificationDate() |
long |
getContentDispositionSize()
Gets the size parameter value of the content-disposition field. |
MimeException |
getContentDispositionSizeParseException()
Gets any exception thrown during the parsing of #getContentReadModificationDate() |
java.lang.String |
getContentDispositionType()
Gets the disposition type of the content-disposition field. |
java.lang.String |
getContentId()
Gets the value of the RFC Content-ID header. |
java.util.List |
getContentLanguage()
Get the content-language header values. |
MimeException |
getContentLanguageParseException()
Gets any exception thrown during the parsing of RFC3066ContentLanguageDescriptor.getContentLanguage() |
java.lang.String |
getContentLocation()
Get the content-location header value. |
MimeException |
getContentLocationParseException()
Gets any exception thrown during the parsing of #getContentLanguage() |
java.lang.String |
getContentMD5Raw()
Gets the raw, Base64 encoded value of the Content-MD5 field. |
int |
getMimeMajorVersion()
Gets the MIME major version as specified by the MIME-Version
header. |
int |
getMimeMinorVersion()
Gets the MIME minor version as specified by the MIME-Version
header. |
MimeException |
getMimeVersionParseException()
When the MIME version header exists but cannot be parsed this field will be contain the exception. |
Methods inherited from class org.apache.james.mime4j.descriptor.DefaultBodyDescriptor |
---|
getBoundary, getCharset, getContentLength, getContentTypeParameters, getMediaType, getMimeType, getSubType, getTransferEncoding, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.james.mime4j.descriptor.ContentDescriptor |
---|
getCharset, getContentLength, getContentTypeParameters, getMediaType, getMimeType, getSubType, getTransferEncoding |
Constructor Detail |
---|
protected MaximalBodyDescriptor()
public MaximalBodyDescriptor(BodyDescriptor parent)
Method Detail |
---|
public void addField(java.lang.String name, java.lang.String value)
DefaultBodyDescriptor
Content-
header field of
a MIME message or part.
addField
in interface MutableBodyDescriptor
addField
in class DefaultBodyDescriptor
name
- the field name.value
- the field value.public int getMimeMajorVersion()
RFC2045MimeDescriptor
MIME-Version
header.
Defaults to one.
getMimeMajorVersion
in interface RFC2045MimeDescriptor
RFC2045MimeDescriptor.getMimeMajorVersion()
public int getMimeMinorVersion()
RFC2045MimeDescriptor
MIME-Version
header.
Defaults to zero.
getMimeMinorVersion
in interface RFC2045MimeDescriptor
RFC2045MimeDescriptor.getMimeMinorVersion()
public MimeException getMimeVersionParseException()
RFC2045MimeDescriptor
getMimeVersionParseException
in interface RFC2045MimeDescriptor
MimeException
if the mime header cannot
be parsed, null otherwiseRFC2045MimeDescriptor.getMimeVersionParseException()
public java.lang.String getContentDescription()
RFC2045MimeDescriptor
Content-Description
header.
getContentDescription
in interface RFC2045MimeDescriptor
Content-Description
when present,
null otherwiseRFC2045MimeDescriptor.getContentDescription()
public java.lang.String getContentId()
RFC2045MimeDescriptor
Content-ID
header.
getContentId
in interface RFC2045MimeDescriptor
Content-ID
when present,
null otherwiseRFC2045MimeDescriptor.getContentId()
public java.lang.String getContentDispositionType()
RFC2183ContentDispositionDescriptor
content-disposition
field.
The value is case insensitive and will be converted to lower case.
See RFC2183.
getContentDispositionType
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionType()
public java.util.Map getContentDispositionParameters()
RFC2183ContentDispositionDescriptor
content-disposition
field.
See RFC2183.
getContentDispositionParameters
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionParameters()
public java.lang.String getContentDispositionFilename()
RFC2183ContentDispositionDescriptor
filename
parameter value of the content-disposition
field.
See RFC2183.
getContentDispositionFilename
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionFilename()
public DateTime getContentDispositionModificationDate()
RFC2183ContentDispositionDescriptor
modification-date
parameter value of the content-disposition
field.
See RFC2183.
getContentDispositionModificationDate
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionModificationDate()
public MimeException getContentDispositionModificationDateParseException()
RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionModificationDate()
getContentDispositionModificationDateParseException
in interface RFC2183ContentDispositionDescriptor
ParseException
when the modification-date parse fails,
null otherwiseRFC2183ContentDispositionDescriptor.getContentDispositionModificationDateParseException()
public DateTime getContentDispositionCreationDate()
RFC2183ContentDispositionDescriptor
creation-date
parameter value of the content-disposition
field.
See RFC2183.
getContentDispositionCreationDate
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionCreationDate()
public MimeException getContentDispositionCreationDateParseException()
RFC2183ContentDispositionDescriptor
#getContentCreationModificationDate()
getContentDispositionCreationDateParseException
in interface RFC2183ContentDispositionDescriptor
ParseException
when the creation-date parse fails,
null otherwiseRFC2183ContentDispositionDescriptor.getContentDispositionCreationDateParseException()
public DateTime getContentDispositionReadDate()
RFC2183ContentDispositionDescriptor
read-date
parameter value of the content-disposition
field.
See RFC2183.
getContentDispositionReadDate
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionReadDate()
public MimeException getContentDispositionReadDateParseException()
RFC2183ContentDispositionDescriptor
#getContentReadModificationDate()
getContentDispositionReadDateParseException
in interface RFC2183ContentDispositionDescriptor
ParseException
when the read-date parse fails,
null otherwiseRFC2183ContentDispositionDescriptor.getContentDispositionReadDateParseException()
public long getContentDispositionSize()
RFC2183ContentDispositionDescriptor
size
parameter value of the content-disposition
field.
See RFC2183.
getContentDispositionSize
in interface RFC2183ContentDispositionDescriptor
RFC2183ContentDispositionDescriptor.getContentDispositionSize()
public MimeException getContentDispositionSizeParseException()
RFC2183ContentDispositionDescriptor
#getContentReadModificationDate()
getContentDispositionSizeParseException
in interface RFC2183ContentDispositionDescriptor
ParseException
when the read-date parse fails,
null otherwiseRFC2183ContentDispositionDescriptor.getContentDispositionSizeParseException()
public java.util.List getContentLanguage()
RFC3066ContentLanguageDescriptor
content-language
header values.
Each applicable language tag will be returned in order.
See RFC4646
http://tools.ietf.org/html/rfc4646.
getContentLanguage
in interface RFC3066ContentLanguageDescriptor
RFC3066ContentLanguageDescriptor.getContentLanguage()
public MimeException getContentLanguageParseException()
RFC3066ContentLanguageDescriptor
RFC3066ContentLanguageDescriptor.getContentLanguage()
getContentLanguageParseException
in interface RFC3066ContentLanguageDescriptor
ParseException
when the content-language parse fails,
null otherwiseRFC3066ContentLanguageDescriptor.getContentLanguageParseException()
public java.lang.String getContentLocation()
RFC2557ContentLocationDescriptor
content-location
header value.
See RFC2557
getContentLocation
in interface RFC2557ContentLocationDescriptor
RFC2557ContentLocationDescriptor.getContentLocation()
public MimeException getContentLocationParseException()
RFC2557ContentLocationDescriptor
#getContentLanguage()
getContentLocationParseException
in interface RFC2557ContentLocationDescriptor
ParseException
when the content-language parse fails,
null otherwiseRFC2557ContentLocationDescriptor.getContentLocationParseException()
public java.lang.String getContentMD5Raw()
RFC1864ContentMD5Descriptor
Content-MD5
field.
See RFC1864.
getContentMD5Raw
in interface RFC1864ContentMD5Descriptor
RFC1864ContentMD5Descriptor.getContentMD5Raw()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |