com.hcl.domino.mime

Class MimeData

java.lang.Object

com.hcl.domino.mime.MimeData

public class MimeData
extends Object

Container for text and binary data of an item of type ItemDataType.TYPE_MIME_PART. Use TypedAccess.get(String, Class, Object) with MimeData to return the item value in this format or Document.replaceItemValue(String, Object) to write it.

Constructor Summary

Constructors

Constructor and Description
MimeData()
MimeData(String html, String text, Map<String,IMimeAttachment> embeds, List<IMimeAttachment> attachments)

Method Summary

Modifier and Type	Method and Description
void	attach(IMimeAttachment attachment) Attaches a file.
String	embed(IMimeAttachment attachment) Adds an inline file
void	embed(String cid, IMimeAttachment attachment) Adds/changes an inline file with a given content id
List<IMimeAttachment>	getAttachments()
Iterable<String>	getContentIds() Returns the content ids for all inline files.
Optional<IMimeAttachment>	getEmbed(String cid) Returns an attachment for a content id
String	getHtml() Returns the html content
String	getPlainText() Returns alternative plaintext content
void	removeAttachment(IMimeAttachment attachment) Removes an attachment from the MIME data
void	removeEmbed(String cid) Removes an inline file
void	setHtml(String html) Sets the HTML content
void	setPlainText(String text) Sets the alternative plaintext content
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeData

public MimeData()

MimeData

public MimeData(String html,
                String text,
                Map<String,IMimeAttachment> embeds,
                List<IMimeAttachment> attachments)

Method Detail

getHtml

public String getHtml()

Returns the html content

Returns:

HTML, not null

setHtml

public void setHtml(String html)

Sets the HTML content

Parameters:

html - html

getPlainText

public String getPlainText()

Returns alternative plaintext content

Returns:

plaintext content or empty string

setPlainText

public void setPlainText(String text)

Sets the alternative plaintext content

Parameters:

text - plaintext

getEmbed

public Optional<IMimeAttachment> getEmbed(String cid)

Returns an attachment for a content id

Parameters:

cid - content id

Returns:

an Optional describing the attachment, or an empty one if the attachment with that ID does not exist

embed

public String embed(IMimeAttachment attachment)

Adds an inline file

Parameters:

attachment - attachment

Returns:

unique content id

embed

public void embed(String cid,
                  IMimeAttachment attachment)

Adds/changes an inline file with a given content id

Parameters:

cid - content id

attachment - attachment

removeEmbed

public void removeEmbed(String cid)

Removes an inline file

Parameters:

cid - content id

getContentIds

public Iterable<String> getContentIds()

Returns the content ids for all inline files.

Returns:

content ids

attach

public void attach(IMimeAttachment attachment)

Attaches a file. We provide several implementations for IMimeAttachment, e.g. LocalFileMimeAttachment, ByteArrayMimeAttachment or UrlMimeAttachment or you can add your own implementation. When reading MimeData from a document, we transform the attachment to an internal class that returns the same filename, content type and binary content.

Parameters:

attachment - attachment

getAttachments

public List<IMimeAttachment> getAttachments()

removeAttachment

public void removeAttachment(IMimeAttachment attachment)

Removes an attachment from the MIME data

Parameters:

attachment - attachment to remove

toString

public String toString()

Overrides:

toString in class Object