SilverStream
Application Server 3.5

com.sssw.srv.mail
Class AgoMIMEHeaderField

java.lang.Object
 |
 +--com.sssw.srv.mail.AgoRFC822HeaderField
       |
       +--com.sssw.srv.mail.AgoMIMEHeaderField

public class AgoMIMEHeaderField
extends AgoRFC822HeaderField

This class adds the ability to specify/access header field parameters, as defined in MIME. It stores the MIME header fields. A header field has a name, a value, and an optional set of parameters.


Constructor Summary
AgoMIMEHeaderField(String fieldname, String fieldvalue)
          The constructor for the AgoMIMEHeaderField class.
 
Method Summary
 String getParameter(String arrtibute)
          Returns the value of a parameter.
 void setParameter(String arrtibute, String value)
          Sets the value of a named parameter.
 String value()
          Return the value of the field
 void write(OutputStream outputstream)
          Writes the header field to the specified output stream in a format suitable for a mail header
 
Methods inherited from class com.sssw.srv.mail.AgoRFC822HeaderField
getName, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AgoMIMEHeaderField

public AgoMIMEHeaderField(String fieldname,
                          String fieldvalue)
The constructor for the AgoMIMEHeaderField class.
Parameters:
fieldname - the name of the header field.
fieldvalue - the value of the named header field.
Example:
     AgoMIMEHeaderField hField = new AgoMIMEHeaderField(fieldNameString,fieldValueString);
 
Method Detail

value

public String value()
Return the value of the field

setParameter

public void setParameter(String arrtibute,
                         String value)
Sets the value of a named parameter.
Parameters:
attribute - the name of the parameter.
value - the value to set the parameter.
Usage:

The name of the parameter must be a valid MIME token or a quoted MIME String.

Example:
     hField.setParameter(attributeString,valueString);
 
See Also:
AgoMIMEHeaderField.getParameter( String arrtibute )

getParameter

public String getParameter(String arrtibute)
Returns the value of a parameter.
Parameters:
attribute - the name of the parameter to be obtained.
Usage:

Example:
     String param;
     param = hField.getParameter(attributeString);
 
See Also:
AgoMIMEHeaderField.setParameter( String arrtibute, String value )

write

public void write(OutputStream outputstream)
           throws IOException
Writes the header field to the specified output stream in a format suitable for a mail header
Overrides:
write in class AgoRFC822HeaderField
Parameters:
outputStream - the output stream to write to.
Usage:

Overrides AgoRFC822HeaderField.write( OutputStream outputstream ).

Example:
     hField.write(someOutputStream);
 

SilverStream
Application Server 3.5