org.columba.ristretto.message

Class MimeHeader

java.lang.Object

org.columba.ristretto.message.MimeHeader

All Implemented Interfaces:

java.io.Serializable, Streamable

public class MimeHeader
extends java.lang.Object
implements Streamable, java.io.Serializable

Wrapper around a Header to convieniently access Mime-Specific header fields.

Author:

Timo Stich

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE64 Transfer encoding.
static int	PLAIN Transfer encoding.
static int	QUOTED_PRINTABLE Transfer encoding.

Constructor Summary

Constructors

Constructor and Description
MimeHeader() Constructs a MimeHeader with a new instanciated Header.
MimeHeader(Header header) Constructs a MimeHeader from a Header
MimeHeader(java.lang.String type, java.lang.String subtype) Constructs a MimeHeader with a new instanciated Header.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	appendParameter(java.lang.String headerLine, java.lang.String key, java.lang.String value)
int	count()
java.lang.String	get(java.lang.String key) Get the Header for the specified key.
java.nio.charset.Charset	getCharset() Gets the charset this mime-part is encoded in.
java.lang.String	getContentDescription() Gets the content description of the mime-part.
java.lang.String	getContentDisposition() Gets the content-disposition of the mime-part.
java.lang.String	getContentID() Gets the content id of the mime-part.
java.lang.String	getContentParameter(java.lang.String key) Gets a content parameter of the mime-part.
java.lang.String	getContentSubtype() Deprecated. Use getMimeType() instead
int	getContentTransferEncoding() Gets the content transfer encoding of the mime-part.
java.lang.String	getContentType() Deprecated. Use getMimeType() instead
java.lang.String	getDispositionParameter(java.lang.String key) Gets a parameter of the content disposition of the mime-part.
java.lang.String	getFileName() Gets the filename of the mime-part.
Header	getHeader()
java.io.InputStream	getInputStream()
MimeType	getMimeType() Gets the MimeType of the mime-part.
protected java.lang.String	getParameter(java.lang.String headerLine, java.lang.String key)
void	putContentParameter(java.lang.String key, java.lang.String value) Adds a content parameter to the mime-part.
void	putDispositionParameter(java.lang.String key, java.lang.String value) Adds a parameter to the content disposition of the mime-part.
void	set(java.lang.String key, java.lang.Object value) Set the header with the specified value.
void	setContentDescription(java.lang.String description) Sets the content description of the mime-part.
void	setContentDisposition(java.lang.String disposition) Sets the content-disposition of the mime-part.
void	setContentID(java.lang.String id) Sets the content id of the mime-part.
void	setContentTransferEncoding(java.lang.String encoding) Sets the content transfer encoding of the mime-part.
void	setHeader(Header header) Set the Header.
void	setMimeType(MimeType type) Sets the mime-type of the mime-part.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLAIN

public static final int PLAIN

Transfer encoding.

See Also:

Constant Field Values

QUOTED_PRINTABLE

public static final int QUOTED_PRINTABLE

Transfer encoding.

See Also:

Constant Field Values

BASE64

public static final int BASE64

Transfer encoding.

See Also:

Constant Field Values

Constructor Detail

MimeHeader

public MimeHeader()

Constructs a MimeHeader with a new instanciated Header.

Sets the MimeType to "text/plain".

MimeHeader

public MimeHeader(Header header)

Constructs a MimeHeader from a Header

Parameters:

header -

MimeHeader

public MimeHeader(java.lang.String type,
                  java.lang.String subtype)

Constructs a MimeHeader with a new instanciated Header.

Parameters:

type - type of the mime-part (e.g. text)

subtype - subtype of the mime-part (e.g. plain)

Method Detail

getMimeType

public MimeType getMimeType()

Gets the MimeType of the mime-part.

Intern the MimeTypeParser is used to parse the headerfield "Content-Type" to retrieve the mimetype.

Returns:

MimeType of the mime-part

getContentType

public java.lang.String getContentType()

Deprecated. Use getMimeType() instead

Gets the mimetype of the mime-part (e.g. text)

Returns:

mimetype of the mime-part

getContentSubtype

public java.lang.String getContentSubtype()

Deprecated. Use getMimeType() instead

Gets the mimesubtype of the mime-part (e.g. plain)

Returns:

mimesubtype of the mime-part

getContentDisposition

public java.lang.String getContentDisposition()

Gets the content-disposition of the mime-part. This can be either "attachment" of "inline". MailClients may use this information to either display this mime-part inside the message-body or as a separate attachment

See RFC2183

Returns:

content disposition of the mime-part

getContentParameter

public java.lang.String getContentParameter(java.lang.String key)

Gets a content parameter of the mime-part. This parameter is specified in the "Content-Type" headerfield e.g. the boundary of a multipart or the charset of a text part

See RFC2045

Parameters:

key - the parameter name (e.g. boundary)

Returns:

the value of the parameter or null if not found

getContentTransferEncoding

public int getContentTransferEncoding()

Gets the content transfer encoding of the mime-part. This may be either base64 or quoted-printable.

See RFC2045 for more information about the encodings.

Returns:

the content transfer encoding

getContentID

public java.lang.String getContentID()

Gets the content id of the mime-part. Content IDs are used to reference to e.g. images that are attached to the message inside a html message body.

See RFC2393.

Returns:

content id of the mime-part

getContentDescription

public java.lang.String getContentDescription()

Gets the content description of the mime-part.

See RFC2045

Returns:

the content description

getDispositionParameter

public java.lang.String getDispositionParameter(java.lang.String key)

Gets a parameter of the content disposition of the mime-part. This might be e.g. a filename.

See RFC2183

Parameters:

key -

Returns:

the disposition parameter

getParameter

protected java.lang.String getParameter(java.lang.String headerLine,
                                        java.lang.String key)

appendParameter

protected java.lang.String appendParameter(java.lang.String headerLine,
                                           java.lang.String key,
                                           java.lang.String value)

getFileName

public java.lang.String getFileName()

Gets the filename of the mime-part. Use this method to check both places a filename may be specified:

• as the content-type parameter name
• as the content-disposition parameter filename

Returns:

filename of the mime-part

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

putContentParameter

public void putContentParameter(java.lang.String key,
                                java.lang.String value)

Adds a content parameter to the mime-part. This parameter is specified in the "Content-Type" headerfield e.g. the boundary of a multipart or the charset of a text part

Note: Make sure that you called setMimeType(MimeType) before you call this method, because it will erase all previously added parameters

See RFC2045

Parameters:

key - the parameter name (e.g. boundary)

value - the value of the parameter

putDispositionParameter

public void putDispositionParameter(java.lang.String key,
                                    java.lang.String value)

Adds a parameter to the content disposition of the mime-part. This might be e.g. a filename.

Note: Make sure that you called setContentDisposition(String) before you call this method, because it will erase all previously added parameters

See RFC2183

Parameters:

key -

value -

setMimeType

public void setMimeType(MimeType type)

Sets the mime-type of the mime-part. For text parts of the message this is something like text/plain or text/html, while an image might be of type image/jpeg.

See RFC2046 for more mime-types

Parameters:

type - MimeType of the mime-part

setContentDescription

public void setContentDescription(java.lang.String description)

Sets the content description of the mime-part.

Note: Make sure that you called this method before you call putContentParameter(String,String), because it will erase all previously added parameters

See RFC2045

Parameters:

description - of the mime-part

setContentDisposition

public void setContentDisposition(java.lang.String disposition)

Sets the content-disposition of the mime-part. This can be either "attachment" of "inline". MailClients may use this information to either display this mime-part inside the message-body or as a separate attachment

Note: Make sure that you called this method before you call putDispositionParameter(String,String), because it will erase all previously added parameters

See RFC2183

Parameters:

disposition - of the message

setContentID

public void setContentID(java.lang.String id)

Sets the content id of the mime-part. Content IDs are used to reference to e.g. images that are attached to the message inside a html message body.

See RFC2393.

Parameters:

id - of the mime-part

setContentTransferEncoding

public void setContentTransferEncoding(java.lang.String encoding)

Sets the content transfer encoding of the mime-part. This may be either base64 or quoted-printable.

See RFC2045 for more information about the encodings.

Parameters:

encoding - of the mime-part

count

public int count()

Returns:

the number of defined Headers.

get

public java.lang.String get(java.lang.String key)

Get the Header for the specified key.

Parameters:

key -

Returns:

the Header

set

public void set(java.lang.String key,
                java.lang.Object value)

Set the header with the specified value.

Parameters:

key -

value -

getCharset

public java.nio.charset.Charset getCharset()

Gets the charset this mime-part is encoded in. If no charset parameter is found or the charset is not supported by the VM the default charset of the system is returned.

Returns:

Charset of the mime-part

getHeader

public Header getHeader()

Returns:

the Header

setHeader

public void setHeader(Header header)

Set the Header.

Parameters:

header -

getInputStream

public java.io.InputStream getInputStream()

Specified by:

getInputStream in interface Streamable

Returns:

returns the InputStream of the data structure.

See Also:

Streamable.getInputStream()