com.groupdocs.viewer.converter.options

Class OutlookOptions



  • public class OutlookOptions
    extends Object

    The Outlook data file documents rendering options (OST/PST formats).

    • Constructor Detail

      • OutlookOptions

        public OutlookOptions()
    • Method Detail

      • getAddressFilter

        public final String getAddressFilter()

        Filters messages that are rendered by specified sender or recipient.

        Returns:
        The address filter
      • getTextFilter

        public final String getTextFilter()

        Filters messages that are rendered by specified keywords.

        Returns:
        The text filter
      • setAddressFilter

        public final void setAddressFilter(String value)

        Filters messages that are rendered by specified sender or recipient.

        Parameters:
        value - The address filter
      • setFolderName

        public final void setFolderName(String value)

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

        Note:
        When this option is set, messages only from specified folder will be rendered.

        Example:
        The following example demonstrates how to set the name of the outlook folder that should be rendered.

         ViewerHtmlHandler htmlHandler = new ViewerHtmlHandler();
         HtmlOptions options = new HtmlOptions();
         options.getOutlookOptions().setFolderName("Inbox");
        
         String guid = "archive.pst";
         List<PageHtml> pages = htmlHandler.getPages(guid, options);
         

        Parameters:
        value - The name of the folder
      • setMaxItemsInFolder

        public void setMaxItemsInFolder(int value)

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

        Note:
        Outlook data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items (like contacts and tasks) that are rendered. Default value is 50. In order to render all messages, set the value to 0.

        Example:
        The following example demonstrates how to set the maximum number of message to be rendered from outlook data files.

         ViewerHtmlHandler htmlHandler = new ViewerHtmlHandler();
         HtmlOptions options = new HtmlOptions();
         options.getOutlookOptions().setMaxMessagesInFolder(1000);
        
         String guid = "emails.pst";
         List<PageHtml> pages = htmlHandler.getPages(guid, options);
         

        Parameters:
        value -
      • setTextFilter

        public final void setTextFilter(String value)

        Filters messages that are rendered by specified keywords.

        Parameters:
        value - The text filter