com.groupdocs.viewer.options

Class OutlookOptions

java.lang.Object

com.groupdocs.viewer.options.OutlookOptions

public class OutlookOptions
extends Object

Provides options for rendering Outlook data files.

The OutlookOptions class encapsulates various settings and parameters that can be used to control the rendering of Outlook data files (such as PST or OST files) in the GroupDocs.Viewer component.

For details, see the documentation.

Example usage:

 OutlookOptions options = new OutlookOptions();
 options.setAddressFilter("@gmail.com");
 options.setFolder("folderName");

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

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

See Also:

Viewer

Constructor Summary

Constructors

Constructor and Description
OutlookOptions()

Method Summary

Modifier and Type	Method and Description
String	getAddressFilter() Gets the email address used to filter messages by sender or recipient.
String	getFolder() Gets the name of the folder to render.
int	getMaxItemsInFolder() Gets the maximum number of messages or items that can be rendered from one folder.
String	getTextFilter() Gets the keywords used to filter messages.
void	setAddressFilter(String value) Sets the email address used to filter messages by sender or recipient.
void	setFolder(String value) Sets the name of the folder to render.
void	setMaxItemsInFolder(int value) Sets the maximum number of messages or items that can be rendered from one folder.
void	setTextFilter(String value) Gets 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

OutlookOptions

public OutlookOptions()

Method Detail

getAddressFilter

public final 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 to filter messages.

getFolder

public final String getFolder()

Gets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this documentation.

Returns:

the name of the folder to render.

getMaxItemsInFolder

public final int getMaxItemsInFolder()

Gets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the documentation.

Returns:

the maximum number of messages or items that can be rendered from one folder.

getTextFilter

public final 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.

setAddressFilter

public final void setAddressFilter(String value)

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:

value - The email address used to filter messages.

setFolder

public final void setFolder(String value)

Sets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this documentation.

Parameters:

value - The name of the folder to render.

setMaxItemsInFolder

public final void setMaxItemsInFolder(int value)

Sets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the documentation.

Parameters:

value - The maximum number of messages or items that can be rendered from one folder.

setTextFilter

public final void setTextFilter(String value)

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.

Parameters:

value - The keywords.