com.hcl.domino.mime

Interface MimeWriter

public interface MimeWriter

Utility class to write MIME data to a document

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MimeWriter.WriteMimeDataType Used to specify which part of the MIME content should be itemized into the document

Method Summary

Modifier and Type	Method and Description
void	convertToMime(Document doc, RichTextMimeConversionSettings convertSettings) This function converts all rich text items (type ItemDataType.TYPE_COMPOSITE) in the document to MIME items (type ItemDataType.TYPE_MIME_PART). It does not update the database; to update the database, save the document.
RichTextMimeConversionSettings	createRichTextMimeConversionSettings() Creates a new RichTextMimeConversionSettings with system default settings.
void	writeMime(Document doc, String itemName, jakarta.mail.Message mimeMessage, Set<MimeWriter.WriteMimeDataType> dataType) Writes the content of a Message to a document.
void	writeMime(Document doc, String itemName, Reader reader, Set<MimeWriter.WriteMimeDataType> dataType) Writes raw MIME content to a document.

Method Detail

writeMime

void writeMime(Document doc,
               String itemName,
               jakarta.mail.Message mimeMessage,
               Set<MimeWriter.WriteMimeDataType> dataType)
        throws IOException,
               jakarta.mail.MessagingException

Writes the content of a Message to a document.

Note: to write the body of the message, the document must be in a database where the current user has at least Author rights.

Parameters:

doc - target document

itemName - name of item used for the MIME data (e.g. "body")

mimeMessage - MIME message to write

dataType - itemize flags (write header, body or both)

Throws:

IOException - in case of I/O errors

jakarta.mail.MessagingException - in case of errors accessing the Message

writeMime

void writeMime(Document doc,
               String itemName,
               Reader reader,
               Set<MimeWriter.WriteMimeDataType> dataType)
        throws IOException

Writes raw MIME content to a document.

Note: to write the body of the message, the document must be in a database where the current user has at least Author rights.

Parameters:

doc - target document

itemName - name of item used for the MIME data (e.g. "body")

reader - reader used to read the MIME content

dataType - itemize flags (write header, body or both)

Throws:

IOException - in case of I/O errors

createRichTextMimeConversionSettings

RichTextMimeConversionSettings createRichTextMimeConversionSettings()

Creates a new RichTextMimeConversionSettings with system default settings.

Returns:

conversion settings

convertToMime

void convertToMime(Document doc,
                   RichTextMimeConversionSettings convertSettings)

This function converts all rich text items (type ItemDataType.TYPE_COMPOSITE) in the document to MIME items (type ItemDataType.TYPE_MIME_PART).

It does not update the database; to update the database, save the document.

Parameters:

doc - document to convert

convertSettings - settings to control the conversion process or null to use the system default