com.groupdocs.viewer.options

Class MailStorageOptions

java.lang.Object

com.groupdocs.viewer.options.MailStorageOptions

public class MailStorageOptions
extends Object

Provides options for rendering Mail storage (Lotus Notes, MBox) data files.

The MailStorageOptions class encapsulates various settings and parameters that can be used to control the rendering of Mail storage data files (such as Lotus Notes or MBox) in the GroupDocs.Viewer component.

For details, see the documentation.

Example usage:

 MailStorageOptions options = new MailStorageOptions();
 options.setAddressFilter("@gmail.com");
 options.setMaxItems(10);

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setMailStorageOptions(options);

 try (Viewer viewer = new Viewer("mail.msg")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 

See Also:

Viewer

Constructor Summary

Constructors

Constructor and Description
MailStorageOptions()

Method Summary

Modifier and Type	Method and Description
String	getAddressFilter() Gets the email address used to filter messages by sender or recipient.
int	getMaxItems() Gets the maximum number of messages or items to render.
String	getTextFilter() Gets the keywords used to filter messages.
void	setAddressFilter(String addressFilter) Sets the email address used to filter messages by sender or recipient.
void	setMaxItems(int maxItems) Sets the maximum number of messages or items to render.
void	setTextFilter(String textFilter) Sets the keywords used to filter messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailStorageOptions

public MailStorageOptions()

Method Detail

getAddressFilter

public String getAddressFilter()

Gets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the documentation.

Returns:

the email address used for filtering messages.

getMaxItems

public int getMaxItems()

Gets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

Note: The default value is 0, which means all messages will be rendered. For code example, see the documentation.

Returns:

the maximum number of messages or items to render.

getTextFilter

public String getTextFilter()

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the documentation.

Returns:

the keywords used for filtering messages.

setAddressFilter

public void setAddressFilter(String addressFilter)

Sets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the documentation.

Parameters:

addressFilter - The email address used for filtering messages.

setMaxItems

public void setMaxItems(int maxItems)

Sets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

Note: The default value is 0, which means all messages will be rendered. For code example, see the documentation.

Parameters:

maxItems - The maximum number of messages or items to render.

setTextFilter

public void setTextFilter(String textFilter)

Sets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the documentation.

Parameters:

textFilter - The keywords used for filtering messages.