com.hcl.domino.mime

Interface RichTextMimeConversionSettings

All Superinterfaces:

IAdaptable

public interface RichTextMimeConversionSettings
extends IAdaptable

Settings to control the rich text to MIME conversion

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RichTextMimeConversionSettings.AttachmentEncoding
static class	RichTextMimeConversionSettings.MessageContentEncoding
static class	RichTextMimeConversionSettings.ReadReceipt
static class	RichTextMimeConversionSettings.Typeface

Method Summary

Modifier and Type	Method and Description
List<String>	getAddItems() The function returns the Conversions Controls 'add items setting' setting.
Optional<RichTextMimeConversionSettings.AttachmentEncoding>	getAttachmentEncoding() The function returns the Conversions Controls 'attachment encoding' setting.
List<String>	getDropItems() The function returns the Conversions Controls 'drop items' setting.
Optional<RichTextMimeConversionSettings.MessageContentEncoding>	getMessageContentEncoding() The function returns the current Conversions Controls 'message content encoding' setting.
int	getPointSize() The function returns the Conversions Controls 'point size' setting.
Optional<RichTextMimeConversionSettings.ReadReceipt>	getReadReceipt() The function returns the Conversions Controls 'read receipt' setting.
boolean	getSkipX() The function returns the Conversions Controls 'skip X-Notes-Item headers' setting.
Optional<RichTextMimeConversionSettings.Typeface>	getTypeface() The function returns the Conversions Controls 'typeface' setting.
boolean	isKeepTabs() The function returns the Conversions Controls 'keep tabs' setting.
RichTextMimeConversionSettings	setAddItems(List<String> itemNames) The function sets the Conversions Controls 'add items setting' setting to the input value.
RichTextMimeConversionSettings	setAttachmentEncoding(RichTextMimeConversionSettings.AttachmentEncoding encoding) The function sets the Conversions Controls 'attachment encoding' setting to the input value.
RichTextMimeConversionSettings	setDefaults() The function sets Conversion Controls configuration settings to their default values.
RichTextMimeConversionSettings	setDropItems(List<String> itemNames) The function sets the Conversions Controls 'drop items setting' setting to the input value, a list of items to drop during export.
RichTextMimeConversionSettings	setKeepTabs(boolean b) The function sets the Conversions Controls 'keep tabs' setting to the input value.
RichTextMimeConversionSettings	setMessageContentEncoding(RichTextMimeConversionSettings.MessageContentEncoding enc) The function sets the Conversions Controls 'message content encoding' setting to the input value.
RichTextMimeConversionSettings	setPointSize(int size) The function sets the Conversions Controls 'point size' setting to the input value.
RichTextMimeConversionSettings	setReadReceipt(RichTextMimeConversionSettings.ReadReceipt rc) The function sets the Conversions Controls read receipt setting to the input value
RichTextMimeConversionSettings	setSkipX(boolean b) The function sets the Conversions Controls 'skip X-Notes-Item headers' setting to the input value.
RichTextMimeConversionSettings	setTypeface(RichTextMimeConversionSettings.Typeface tf) The function sets the Conversions Controls 'typeface' setting to the input value.

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Method Detail

setDefaults

RichTextMimeConversionSettings setDefaults()

The function sets Conversion Controls configuration settings to their default values.

Returns:

this instance

getAttachmentEncoding

Optional<RichTextMimeConversionSettings.AttachmentEncoding> getAttachmentEncoding()

The function returns the Conversions Controls 'attachment encoding' setting.

Returns:

an Optional describing the attachment encoding, or an empty one if known return value

setAttachmentEncoding

RichTextMimeConversionSettings setAttachmentEncoding(RichTextMimeConversionSettings.AttachmentEncoding encoding)

The function sets the Conversions Controls 'attachment encoding' setting to the input value.

Parameters:

encoding - new encoding

Returns:

this instance

getDropItems

List<String> getDropItems()

The function returns the Conversions Controls 'drop items' setting.

Returns:

list of items to drop during export

setDropItems

RichTextMimeConversionSettings setDropItems(List<String> itemNames)

The function sets the Conversions Controls 'drop items setting' setting to the input value, a list of items to drop during export.

Parameters:

itemNames - item names

Returns:

this instance

isKeepTabs

boolean isKeepTabs()

The function returns the Conversions Controls 'keep tabs' setting.

Returns:

true to keep tabs

setKeepTabs

RichTextMimeConversionSettings setKeepTabs(boolean b)

The function sets the Conversions Controls 'keep tabs' setting to the input value.

Parameters:

b - true to keep tabs

Returns:

this instance

getPointSize

int getPointSize()

The function returns the Conversions Controls 'point size' setting.

Returns:

point size

setPointSize

RichTextMimeConversionSettings setPointSize(int size)

The function sets the Conversions Controls 'point size' setting to the input value.

Parameters:

size - new size, one of: 6, 8, 9, 10 (default), 12, 14, 18, 24

Returns:

this instance

getTypeface

Optional<RichTextMimeConversionSettings.Typeface> getTypeface()

The function returns the Conversions Controls 'typeface' setting.

Returns:

an Optional describing the typeface, or an empty one if we received an unknown value

setTypeface

RichTextMimeConversionSettings setTypeface(RichTextMimeConversionSettings.Typeface tf)

The function sets the Conversions Controls 'typeface' setting to the input value.

Parameters:

tf - new typeface

Returns:

this instance

getAddItems

List<String> getAddItems()

The function returns the Conversions Controls 'add items setting' setting.

Returns:

list of items to add during export

setAddItems

RichTextMimeConversionSettings setAddItems(List<String> itemNames)

The function sets the Conversions Controls 'add items setting' setting to the input value.

Parameters:

itemNames - item names, list of item names to preserve in msgs as they are exported (default is empty list)

Returns:

this instance

getMessageContentEncoding

Optional<RichTextMimeConversionSettings.MessageContentEncoding> getMessageContentEncoding()

The function returns the current Conversions Controls 'message content encoding' setting.

Returns:

an Optional describing the encoding, or an empty one if unknown value received

setMessageContentEncoding

RichTextMimeConversionSettings setMessageContentEncoding(RichTextMimeConversionSettings.MessageContentEncoding enc)

The function sets the Conversions Controls 'message content encoding' setting to the input value.

Parameters:

enc - encoding

Returns:

this instance

getReadReceipt

Optional<RichTextMimeConversionSettings.ReadReceipt> getReadReceipt()

The function returns the Conversions Controls 'read receipt' setting.

Returns:

an Optional describing the read receipt, or an empty one if we received an unknown value

setReadReceipt

RichTextMimeConversionSettings setReadReceipt(RichTextMimeConversionSettings.ReadReceipt rc)

The function sets the Conversions Controls read receipt setting to the input value

Parameters:

rc - read receipt

Returns:

this instance

getSkipX

boolean getSkipX()

The function returns the Conversions Controls 'skip X-Notes-Item headers' setting.

Returns:

if TRUE, don't export any headers named x-notes-item (default FALSE)

setSkipX

RichTextMimeConversionSettings setSkipX(boolean b)

The function sets the Conversions Controls 'skip X-Notes-Item headers' setting to the input value.

Parameters:

b - if TRUE, don't export any headers named x-notes-item (default FALSE)

Returns:

this instance