com.hcl.domino.keep.tools

Class MimeHelper

java.lang.Object

com.hcl.domino.keep.tools.MimeHelper

public class MimeHelper
extends java.lang.Object

Helper functions for conversion from/to MIME entries

Constructor Summary

Constructors

Constructor and Description
MimeHelper() Default constructor
MimeHelper(java.lang.String bodyfield) Constructor that allows to define the body field

Method Summary

Modifier and Type	Method and Description
io.vertx.core.buffer.Buffer	docMime2Buffer(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, java.lang.String mimeType, int sibling)
void	docMime2Html(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, int sibling, java.io.OutputStream out)
io.vertx.core.json.JsonObject	docMime2Json(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, int sibling)
void	docMime2Stream(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, java.lang.String mimeType, int sibling, java.io.OutputStream out) Extracts a MIME part as Stream from a Document, since there might be multiple parts of the same type sibling can be specified, defaults to 0 - first found
java.lang.String	json2Mime(io.vertx.core.json.JsonObject source, java.util.Collection<java.lang.String> fields, java.lang.String creator, java.lang.String templateName) Creates a MIME formatted message to store JSON and a pretty text representation
void	mime2doc(KeepJnxSession session, com.hcl.domino.data.Document doc, java.lang.String message, java.util.List<java.lang.String> headerNames) Writes MIME content out into a Note By nature of Mime, Mime only gets appended, so we need to clear fields and most important the Body before commencing
io.vertx.core.buffer.Buffer	noteMime2Buffer(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, java.lang.String mimeType, int sibling) Extracts a MIME part as buffer from a Document, since there might be multiple parts of the same type sibling can be specified, defaults to 0 - first found
io.vertx.core.json.JsonObject	noteMime2Json(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, int sibling)

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeHelper

public MimeHelper()

Default constructor

MimeHelper

public MimeHelper(java.lang.String bodyfield)

Constructor that allows to define the body field

Parameters:

bodyfield - Name of the field for the MimeBody

Method Detail

docMime2Buffer

public io.vertx.core.buffer.Buffer docMime2Buffer(com.hcl.domino.DominoClient client,
                                                  com.hcl.domino.data.Document doc,
                                                  java.lang.String mimeType,
                                                  int sibling)

Parameters:

client -

doc -

mimeType -

sibling -

Returns:

a buffer with hoepfully JSON

docMime2Html

public void docMime2Html(@Nonnull
                         com.hcl.domino.DominoClient client,
                         @Nonnull
                         com.hcl.domino.data.Document doc,
                         int sibling,
                         java.io.OutputStream out)

Parameters:

client -

• Domino client with API

doc -

• Document with MIME content

sibling - which entry if there are more than one. default = 0

out -

docMime2Json

public io.vertx.core.json.JsonObject docMime2Json(com.hcl.domino.DominoClient client,
                                                  com.hcl.domino.data.Document doc,
                                                  int sibling)

Parameters:

client -

doc -

sibling -

Returns:

a JsonObject or null

docMime2Stream

public void docMime2Stream(@Nonnull
                           com.hcl.domino.DominoClient client,
                           @Nonnull
                           com.hcl.domino.data.Document doc,
                           @Nonnull
                           java.lang.String mimeType,
                           int sibling,
                           java.io.OutputStream out)

Extracts a MIME part as Stream from a Document, since there might be multiple parts of the same type sibling can be specified, defaults to 0 - first found

Parameters:

doc - Document to retrieve data from

mimeType - the mime type to retrieve e.g. “application/json”

sibling - what element to retrieve, default to 0

out -

json2Mime

public java.lang.String json2Mime(io.vertx.core.json.JsonObject source,
                                  java.util.Collection<java.lang.String> fields,
                                  java.lang.String creator,
                                  java.lang.String templateName)

Creates a MIME formatted message to store JSON and a pretty text representation

Parameters:

source -

• JSON field

fields -

• fields to become notes items

creator -

• who updated this

templateName -

• MustacheTemplate for visuals

Returns:

String with Mime Message

mime2doc

public void mime2doc(KeepJnxSession session,
                     @Nonnull
                     com.hcl.domino.data.Document doc,
                     @Nonnull
                     java.lang.String message,
                     @Nonnull
                     java.util.List<java.lang.String> headerNames)
              throws java.io.IOException

Writes MIME content out into a Note By nature of Mime, Mime only gets appended, so we need to clear fields and most important the Body before commencing

Parameters:

session -

doc -

• A Document to save the mime message to

message -

• the mime formatted message / data

headerNames -

• The list of header that will be updated

Throws:

java.io.IOException

noteMime2Buffer

public io.vertx.core.buffer.Buffer noteMime2Buffer(@Nonnull
                                                   com.hcl.domino.DominoClient client,
                                                   @Nonnull
                                                   com.hcl.domino.data.Document doc,
                                                   @Nonnull
                                                   java.lang.String mimeType,
                                                   int sibling)

Extracts a MIME part as buffer from a Document, since there might be multiple parts of the same type sibling can be specified, defaults to 0 - first found

Parameters:

doc - Document to retrieve data from

mimeType - the mime type to retrieve e.g. “application/json”

sibling - what element to retrieve, default to 0

Returns:

Buffer with content found or empty buffer

noteMime2Json

public io.vertx.core.json.JsonObject noteMime2Json(@Nonnull
                                                   com.hcl.domino.DominoClient client,
                                                   @Nonnull
                                                   com.hcl.domino.data.Document doc,
                                                   int sibling)

Parameters:

doc -

• Document with MIME content

sibling - which entry if there are more than one. default = 0

Returns:

a JsonObject or null if not found