ipworks
Class MIMEPart

java.lang.Object
  |
  +--ipworks.MIMEPart

public class MIMEPart

extends java.lang.Object

A part of the MIME message.

Each MIME message is split into parts. A message must have at least one part to be a valid MIME message. The message itself is split into the MessageHeaders and the Message body. The body is then split into MIME parts by a specified or generated Boundary . Each part of a MIME message has its own Headers as well. These headers describe the MIMEPART and its contents.

The decoded data will be held in DecodedString or otherwise saved in a temporary file given by DecodedFile when the user asks for the value of the respective field.

If the encoded data is file data, the decoded file(s) will be given in the DecodedFile field. Otherwise, the decoded data will be in the DecodedString field.

When the EncodeToString method is called, the bean will check for each item in the Parts collection (first the DecodedFile and then the DecodedString ) for the data to encode.

ContentDisposition: Content Disposition for each part.

This value is used in the Content-Disposition header. Typical values include "form-data", "attachment" etc. The bean fills it out each time the DecodedFile is changed. Changing the ContentDisposition recalculates the Headers as well.

ContentDispositionAttr: The content disposition's attribute (if any) for each part.

Typical values for ContentDispositionAttr are the names of the form-variables while creating an HTTP post, values for filenames etc.

Setting the ContentDispositionAttr recalculates the Headers .

ContentId: Content id for each part. This value is used in the Content-Id header. The bean fills it out each time the DecodedFile is changed. Changing the ContentId recalculates the Headers as well.

ContentType: Content type for each part. This value is used in the Content-Type header. Typical values include "image/gif", "text/plain" etc. The bean fills it out each time the DecodedFile is changed. Changing the ContentType recalculates the Headers as well.

ContentTypeAttr: The content type attribute, if any, for each part. Setting this recalculates the Headers as well.

DecodedFile: The filename with the decoded data. Accessing the DecodedFile for the first time after calling the DecodeFromString or DecodeFromFile method, directs the bean to actually decode the part and save the data in a temporary file. The user is responsible for deleting the temporary file.

Setting a value to DecodedFile directs the component to calculate the file size and fill out the respective Size .

DecodedString: It holds the actual content of each part. The bean decodes the actual part of Message to DecodedString when DecodedString 's value is first queried.

Setting a value to DecodedString fills out the corresponding Size with the string size if the corresponding DecodedFile is empty.

The bean checks during encoding first DecodedFile : if it is empty then the bean uses the value of DecodedString .

Encoding: The actual content encoding type for each part. Encoding determines how to encode the data or how they were actually encoded in the Message as specified in the Content-Transfer-Encoding header.

Possible values for the Encoding are:

pe7bit (0)

7 Bit data, no encoding.

peQuotedPrintable (1)

Quoted-Printable encoding of (typically) text.

peBase64 (2)

Base64 encoding of binary data.

pe8Bit (3)

No encoding, 8 Bit charapers may be contained as well.

peBinary (4)

Binary data without any encoding. Similar to 3 (8 Bit encoding).

Filename: The filename attribute specified in the headers of the part. Changing the value of the corresponding DecodedFile sets automatically the Filename and consequently the Headers .

Headers: Headers for each MIME part. The bean fills out Headers each time any of the other corresponding Part- properties is changed. If additional headers are needed, they should be appended after all the other corresponding Part- properties are set.

Name: The name given to a part, such as the filename. Changing the value of DecodedFile sets automatically the corresponding Name and consequently the Headers .

PartInputStream: A stream which contains the actual content of each part before the message is encoded.

PartOutputStream: The bean decodes the actual part of Message when PartOutputStream 's value is first set, and writes the decoded value to the stream.

Size: The size of the DecodedFile or DecodedString . If a non empty value is assigned to DecodedFile , then bean fills out the corresponding Size with the file size or an error occurrs if the file doesn't exist.

If the DecodedFile is empty and a value is assigned to DecodedString , then the corresponding Size will be equal to the string's size.

During decoding, the Size is filled with the size of that part.

See Also:

Atom, Atom.MIMEPart

Field Summary

static int	pe7Bit
static int	pe8Bit
static int	peBase64
static int	peBinary
static int	peQuotedPrintable

Constructor Summary

MIMEPart()

MIMEPart(byte[] decodedString)

MIMEPart(java.io.InputStream partInputStream)

MIMEPart(java.lang.String decodedFile)

Method Summary

java.lang.String	getContentDisposition()
java.lang.String	getContentDispositionAttr()
java.lang.String	getContentId()
java.lang.String	getContentType()
java.lang.String	getContentTypeAttr()
java.lang.String	getDecodedFile()
byte[]	getDecodedString()
int	getEncoding()
java.lang.String	getFilename()
java.lang.String	getHeaders()
java.lang.String	getName()
java.io.InputStream	getPartInputStream()
java.io.OutputStream	getPartOutputStream()
int	getSize()
void	setContentDisposition(java.lang.String value)
void	setContentDispositionAttr(java.lang.String value)
void	setContentId(java.lang.String value)
void	setContentType(java.lang.String value)
void	setContentTypeAttr(java.lang.String value)
void	setDecodedFile(java.lang.String value)
void	setDecodedString(byte[] value)
void	setEncoding(int value)
void	setFilename(java.lang.String value)
void	setHeaders(java.lang.String value)
void	setName(java.lang.String value)
void	setPartInputStream(java.io.InputStream value)
void	setPartOutputStream(java.io.OutputStream value)

Methods inherited from class java.lang.Object

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

Field Detail

pe7Bit

public static final int pe7Bit

See Also:

Constant Field Values

peQuotedPrintable

public static final int peQuotedPrintable

See Also:

Constant Field Values

peBase64

public static final int peBase64

See Also:

Constant Field Values

pe8Bit

public static final int pe8Bit

See Also:

Constant Field Values

peBinary

public static final int peBinary

See Also:

Constant Field Values

Constructor Detail

MIMEPart

public MIMEPart()

MIMEPart

public MIMEPart(java.lang.String decodedFile)

MIMEPart

public MIMEPart(byte[] decodedString)

MIMEPart

public MIMEPart(java.io.InputStream partInputStream)

Method Detail

getContentDisposition

public java.lang.String getContentDisposition()

setContentDisposition

public void setContentDisposition(java.lang.String value)

getContentDispositionAttr

public java.lang.String getContentDispositionAttr()

setContentDispositionAttr

public void setContentDispositionAttr(java.lang.String value)

getContentId

public java.lang.String getContentId()

setContentId

public void setContentId(java.lang.String value)

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String value)

getContentTypeAttr

public java.lang.String getContentTypeAttr()

setContentTypeAttr

public void setContentTypeAttr(java.lang.String value)

getDecodedFile

public java.lang.String getDecodedFile()

setDecodedFile

public void setDecodedFile(java.lang.String value)

getDecodedString

public byte[] getDecodedString()

setDecodedString

public void setDecodedString(byte[] value)

getEncoding

public int getEncoding()

setEncoding

public void setEncoding(int value)

getFilename

public java.lang.String getFilename()

setFilename

public void setFilename(java.lang.String value)

getHeaders

public java.lang.String getHeaders()

setHeaders

public void setHeaders(java.lang.String value)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String value)

getPartInputStream

public java.io.InputStream getPartInputStream()

setPartInputStream

public void setPartInputStream(java.io.InputStream value)

getPartOutputStream

public java.io.OutputStream getPartOutputStream()

setPartOutputStream

public void setPartOutputStream(java.io.OutputStream value)

getSize

public int getSize()