com.sssw.srv.mail
Class AgoMIMEPartText

java.lang.Object
 |
 +--com.sssw.srv.mail.AgoMIMEPart
       |
       +--com.sssw.srv.mail.AgoMIMEPartText

public class AgoMIMEPartText

extends AgoMIMEPart

Class that stores MIME parts of type text. Some examples include: text/plain for plain, ASCII text, and text/html for HTML text. The AgoMIMEPartAudio class is a subclass of AgoMIMEPart.

Constructor Summary

AgoMIMEPartText(String subtype)
A constructor for the AgoMIMEPartText class.

AgoMIMEPartText(String subtype, AgoRFC822HeaderFieldSet headerfieldset)
A constructor for the AgoMIMEPartText class.

AgoMIMEPartText(String subtype, AgoRFC822HeaderFieldSet headerfieldset, AgoCharSetIdentifier charsetidentifier, AgoEncodingIdentifier encodingidentifier)
A constructor for the AgoMIMEPartText class.

AgoMIMEPartText(String subtype, AgoRFC822HeaderFieldSet headerfieldset, AgoCharSetIdentifier charsetidentifier, AgoEncodingIdentifier encodingidentifier, AgoCharStore value)
A constructor for the AgoMIMEPartText class.

Method Summary

AgoCharSetIdentifier	getCharSetIdentifier() Returns the character set identifier of this MIME part.
AgoEncodingIdentifier	getEncodingIdentifier() Returns the encoding mechanism used for this MIME part.
AgoCharStore	getValue() Get the value descriptor.
void	setCharSet(AgoCharSetIdentifier charsetidentifier) Set the character set identifier to be used for this MIME part.
void	setEncoding(AgoEncodingIdentifier encodingidentifier) Set the encoding identifier to be used for this MIME part.

Methods inherited from class com.sssw.srv.mail.AgoMIMEPart

contentDispositionHeaderField, contentTransferEncodingHeaderField, contentTypeHeaderField, deleteHeaderField, getHeaderField, getHeaderFieldSet, getNameParameterOnContentType, setHeaderField, setHeaderField, setHeaderFieldSet, setNameParameterOnContentType, subtype, type, write, writeHeaderFields

Methods inherited from class java.lang.Object

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

Constructor Detail

AgoMIMEPartText

public AgoMIMEPartText(String subtype)

A constructor for the AgoMIMEPartText class.

Parameters:

subtype - the subtype of this part. For a list of subtypes see supported types and subtypes.

Usage:

The default charset used is "us-ascii" and the default encoding used is "7bit".

Example:

     AgoMIMEPartText part = new AgoMIMEPartText("Hello World!");
 

AgoMIMEPartText

public AgoMIMEPartText(String subtype,
                       AgoRFC822HeaderFieldSet headerfieldset)

A constructor for the AgoMIMEPartText class.

Parameters:

subtype - the subtype of this part. For a list of subtypes see supported types and subtypes.

headerfieldset - a set of headerfields for this part.

Usage:

The default charset used is "us-ascii" and the default encoding used is "7bit".

Example:

     AgoRFC822HeaderFieldSet headers;
     AgoMIMEPartText part = new AgoMIMEPartText("Hello World!", headers);
 

See Also:

AgoRFC822HeaderFieldSet

AgoMIMEPartText

public AgoMIMEPartText(String subtype,
                       AgoRFC822HeaderFieldSet headerfieldset,
                       AgoCharSetIdentifier charsetidentifier,
                       AgoEncodingIdentifier encodingidentifier)

A constructor for the AgoMIMEPartText class.

Parameters:

subtype - the subtype of this part. For a list of subtypes see supported types and subtypes.

headerfieldset - a set of headerfields for this part.

charsetidentifier - specifies the character set to use (e.g. CHARSET_ISO_8859_1). See supported character sets.

encodingidentifier - specifies the encoding mechanism to use (e.g. AgoMIME.MECHANISM_BASE64). See supported encoding mechanisms.

Example:

     AgoRFC822HeaderFieldSet headers;
     AgoMIMEPartText part = new AgoMIMEPartText("Hello World!",
                                                headers,
                                                "iso-8859-1",
                                                quoted-printable");
 

See Also:

AgoRFC822HeaderFieldSet, AgoCharSetIdentifier, AgoEncodingIdentifier

AgoMIMEPartText

public AgoMIMEPartText(String subtype,
                       AgoRFC822HeaderFieldSet headerfieldset,
                       AgoCharSetIdentifier charsetidentifier,
                       AgoEncodingIdentifier encodingidentifier,
                       AgoCharStore value)

A constructor for the AgoMIMEPartText class.

Parameters:

subtype - the MIME subtype for this part. For a list of subtypes see supported types and subtypes.

headerfieldset - a set of headerfields for this part.

charsetidentifier - specifies the character set to use (e.g. CHARSET_ISO_8859_1). See supported character sets.

encodingidentifier - specifies the encoding mechanism to use (e.g. AgoMIME.MECHANISM_BASE64). See supported encoding mechanisms.

Example:

     AgoRFC822HeaderFieldSet headers;
     AgoMIMEPartText part = new AgoMIMEPartText("Hello World!",
                                                headers,
                                                "iso-8859-1",
                                                quoted-printable",
                                                someAgoCharStore);
 

See Also:

AgoRFC822HeaderFieldSet, AgoCharSetIdentifier, AgoEncodingIdentifier

Method Detail

getCharSetIdentifier

public AgoCharSetIdentifier getCharSetIdentifier()

Returns the character set identifier of this MIME part.

Usage:

See supported character sets.

Example:

     AgoCharSetIdentifier charset = part.getCharSetIdentifier();
 

setCharSet

public void setCharSet(AgoCharSetIdentifier charsetidentifier)

Set the character set identifier to be used for this MIME part.

Parameters:

charsetidentifier - specifies the character set (e.g. CHARSET_ISO_8859_1) used in this MIME part. See supported character sets.

Example:

     AgoCharSetIdentifier charset = new AgoCharSetIdentifier(AgoMIME.CHARSET_ISO_8859_1)
     part.setCharSetIdentifier(charset);
 

getEncodingIdentifier

public AgoEncodingIdentifier getEncodingIdentifier()

Returns the encoding mechanism used for this MIME part.

Usage:

See supported encoding mechanisms.

Example:

     AgoEncodingIdentifier encoding = part.getEncodingIdentifier();
 

See Also:

AgoEncodingIdentifier, AgoMIMEPartByteStream.setEncodingIdentifier(AgoEncodingIdentifier encodingidentifier)

setEncoding

public void setEncoding(AgoEncodingIdentifier encodingidentifier)

Set the encoding identifier to be used for this MIME part.

Parameters:

encodingidentifier - specifies the encoding mechanism to use (e.g. AgoMIME.MECHANISM_BASE64). See supported encoding mechanisms.

Example:

     AgoEncodingIdentifier encoding = new AgoEncodingIdentifier(AgoMIME.MECHANISM_QUOTED_PRINTABLE)
     part.setEncodingIdentifier(encoding);
 

See Also:

AgoEncodingIdentifier, AgoMIMEPartText.getEncodingIdentifier()

getValue

public AgoCharStore getValue()
                      throws IOException

Get the value descriptor.

Example:

     AgoCharStore body = part.getValue();