class %Net.MIMEWriter extends %Library.RegisteredObject

%Net.MIMEWriter outputs a MIME document as represented by a top level %Net.MIMEPart with multiple parts specified.

Property Inventory (Including Private)

Method Inventory (Including Private)


property OutputDestination as %String [ Private , InitialExpression = "device" ];
Destination for %Net.MIMEWriter output. Possible values are "file", "stream" and "device".
Property methods: OutputDestinationDisplayToLogical(), OutputDestinationGet(), OutputDestinationIsValid(), OutputDestinationLogicalToDisplay(), OutputDestinationLogicalToOdbc(), OutputDestinationNormalize(), OutputDestinationSet()
property OutputStream as %RawString [ Private ];
Stream for output to stream or file. Will store a stream, but declare as %RegisteredObject to prevent auto create of serial object.
Property methods: OutputStreamGet(), OutputStreamIsValid(), OutputStreamSet()


method OutputToDevice() as %Status [ Language = objectscript ]
OutputToDevice() sets output to the current device which is the default if no output method is specified.
method OutputToFile(filename As %String) as %Status [ Language = objectscript ]
OutputToFile() sets output to be directed to a new file, named filename. The file is created with parameters "WNS".
method OutputToStream(ByRef export As %BinaryStream) as %Status [ Language = objectscript ]
OutputToStream() 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.
method WriteHeader(name As %String, value As %String) [ Language = objectscript ]
Write a header
method WriteMIMEBody(message As %Net.MIMEPart) as %Status [ Language = objectscript ]
WriteMIMEBody() outputs the body of a MIME multipart message. If the messsage is multipart, the caller is expected to output needed headers. If the message, is not multipart, then headers are output.
method WriteMIMEMessage(message As %Net.MIMEPart) as %Status [ Language = objectscript ]
WriteMIMEMessage() outputs a MIME message.

Inherited Members

Inherited Methods (Including Private)