IRISLIB database
MIMEWriter Class Reference
Inheritance diagram for MIMEWriter:
Collaboration diagram for MIMEWriter:

Public Member Functions

_.Library.Status OutputToDevice ()
 <method>OutputToDevice</method> sets output to the current device which More...
 
_.Library.Status OutputToFile (_.Library.String filename)
 <method>OutputToFile</method> sets output to be directed to a More...
 
_.Library.Status OutputToStream (_.Library.BinaryStream export)
 <method>OutputToStream</method> sets output to be directed to a stream. More...
 
 WriteHeader (_.Library.String name, _.Library.String value)
 Write a header.
 
_.Library.Status WriteMIMEBody (_.Net.MIMEPart message)
 <method>WriteMIMEBody</method> outputs the body of a MIME multipart message. More...
 
_.Library.Status WriteMIMEMessage (_.Net.MIMEPart message)
 <method>WriteMIMEMessage</method> outputs a MIME message.
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Private Attributes

 __OutputDestination
 Destination for Net.MIMEWriter output. More...
 
 __OutputStream
 Stream for output to stream or file. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

For information on using this class, see MIME Messages.

Net.MIMEWriter outputs a MIME document as represented by a top-level <class>Net.MIMEPart</class> with multiple parts specified.

Member Function Documentation

◆ OutputToDevice()

_.Library.Status OutputToDevice ( )

<method>OutputToDevice</method> sets output to the current device which

is the default if no output method is specified.

◆ OutputToFile()

_.Library.Status OutputToFile ( _.Library.String  filename)

<method>OutputToFile</method> sets output to be directed to a

new file, named filename. The file is created with parameters "WNS".

◆ OutputToStream()

_.Library.Status OutputToStream ( _.Library.BinaryStream  export)

<method>OutputToStream</method> sets output to be directed to a stream.

export is the exported stream.
If export is the oref of a stream, the MIME document will be written to this existing stream at the current position. If export is "", then a new GlobalBinaryStream will be created to contain the MIME document and its oref returned. In this case, export must be passed by reference.

◆ WriteMIMEBody()

_.Library.Status WriteMIMEBody ( _.Net.MIMEPart  message)

<method>WriteMIMEBody</method> outputs the body of a MIME multipart message.

If the message is multipart, the caller is expected to output needed headers. If the message, is not multipart, then headers are output.

Member Data Documentation

◆ __OutputDestination

__OutputDestination
private

Destination for Net.MIMEWriter output.

Possible values are "file", "stream" and "device".  

◆ __OutputStream

__OutputStream
private

Stream for output to stream or file.

Will store a stream, but declare as RegisteredObject to prevent auto create of serial object.