1. GroupDocs Cloud Documentation
    2. /
    3. GroupDocs.Viewer Cloud
    4. /
    5. Developer Guide
    6. /
    7. Advanced usage
    8. /
    9. Rendering options by document type
    10. /
    11. Rendering Outlook Data Files
    12. /
    13. Filter messages

    Filter messages

    On this page

    MS Outlook allows to filter messages inside folders by some text value from message content and by part of the sender’s or recipient’s address.

    GroupDocs.Viewer Cloud also allows filtering the rendered messages using the following filters:

    • Filter by subject and content using OutlookOptions.TextFilter;
    • Filter by the sender’s and recipient’s email addresses using OutlookOptions.AddressFilter;

    API Usage

    There are steps that usage of GroupDocs.Viewer Cloud consists of:

    1. Upload input document into cloud storage
    2. Render document or get document info
    3. Download rendered document from storage

    Steps 1 and 3 are storage operations, please refer to this File API documentation for usage details.

    Swagger UI lets you call this REST API directly from the browser.

    cURL example 

    # First, get JSON Web Token
# Replace $CLIENT_ID and $CLIENT_SECRET with your credentials.
curl -v "https://api.groupdocs.cloud/connect/token" \
  -X POST \
  -d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json"

# Get document information
curl -v "https://api.groupdocs.cloud/v2.0/viewer/view" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -d '{
    "FileInfo": {
      "FilePath": "SampleFiles/sample.ost"
    },
    "ViewFormat": "HTML",
    "RenderOptions": {
      "OutlookOptions": {
        "TextFilter": "Microsoft",
        "AddressFilter": "susan"
      }
    }
  }'

    # First, get JSON Web Token
# Replace $env:CLIENT_ID and $env:CLIENT_SECRET with your credentials.
curl.exe -v "https://api.groupdocs.cloud/connect/token" `
  -X POST `
  -d "grant_type=client_credentials&client_id=$env:CLIENT_ID&client_secret=$env:CLIENT_SECRET" `
  -H "Content-Type: application/x-www-form-urlencoded" `
  -H "Accept: application/json"

# Get document information
curl.exe -v "https://api.groupdocs.cloud/v2.0/viewer/view" `
  -X POST `
  -H "Content-Type: application/json" `
  -H "Accept: application/json" `
  -H "Authorization: Bearer $env:JWT_TOKEN" `
  -d "{
    'FileInfo': {
      'FilePath': 'SampleFiles/sample.ost'
    },
    'ViewFormat': 'HTML',
    'RenderOptions': {
      'OutlookOptions': {
        'TextFilter': 'Microsoft',
        'AddressFilter': 'susan'
      }
    }
  }"

    REM First, get JSON Web Token
REM Replace %CLIENT_ID% and %CLIENT_SECRET% with your credentials.
curl -v "https://api.groupdocs.cloud/connect/token" ^
  -X POST ^
  -d "grant_type=client_credentials&client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%" ^
  -H "Content-Type: application/x-www-form-urlencoded" ^
  -H "Accept: application/json"

REM Get document information
curl -v "https://api.groupdocs.cloud/v2.0/viewer/view" ^
  -X POST ^
  -H "Content-Type: application/json" ^
  -H "Accept: application/json" ^
  -H "Authorization: Bearer %JWT_TOKEN%" ^
  -d "{\"FileInfo\":{\"FilePath\":\"SampleFiles/sample.ost\"},\"ViewFormat\":\"HTML\",\"RenderOptions\":{\"OutlookOptions\":{\"TextFilter\":\"Microsoft\",\"AddressFilter\":\"susan\"}}}"

    {
  "pages": [
    {
      "number": 1,
      "resources": null,
      "path": "viewer/sample_ost/sample_page_1.html",
      "downloadUrl": "https://api.groupdocs.cloud/v2.0/viewer/storage/file/viewer/sample_ost/sample_page_1.html"
    }
  ],
  "attachments": [
    {
      "name": "(Inbox)0.msg",
      "path": "viewer/sample_ost/attachments/(Inbox)0.msg",
      "downloadUrl": "https://api.groupdocs.cloud/v2.0/viewer/storage/file/viewer/sample_ost/attachments/(Inbox)0.msg"
    },
    {
      "name": "(Inbox)1.msg",
      "path": "viewer/sample_ost/attachments/(Inbox)1.msg",
      "downloadUrl": "https://api.groupdocs.cloud/v2.0/viewer/storage/file/viewer/sample_ost/attachments/(Inbox)1.msg"
    },
    {
      "name": "(Inbox)2.msg",
      "path": "viewer/sample_ost/attachments/(Inbox)2.msg",
      "downloadUrl": "https://api.groupdocs.cloud/v2.0/viewer/storage/file/viewer/sample_ost/attachments/(Inbox)2.msg"
    }
  ],
  "file": null
}

    SDK examples

    The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

    SDK Examples 

    // For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-dotnet-samples
string MyClientSecret = ""; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
string MyClientId = ""; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud

var configuration = new Configuration(MyClientId, MyClientSecret);
var apiInstance = new ViewApi(configuration);

var viewOptions = new ViewOptions
{
    FileInfo = new FileInfo
    {
        FilePath = "SampleFiles/sample.ost"
    },
    ViewFormat = ViewOptions.ViewFormatEnum.HTML,
    RenderOptions = new HtmlOptions
    {
        OutlookOptions = new OutlookOptions
        {
            TextFilter = "Microsoft",
            AddressFilter = "susan"
        }
    }
};

var response = apiInstance.CreateView(new CreateViewRequest(viewOptions));

    // For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-java-samples
string MyClientSecret = ""; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
string MyClientId = ""; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud

Configuration configuration = new Configuration(MyClientId, MyClientSecret);
ViewApi apiInstance = new ViewApi(configuration);

FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("SampleFiles/sample.ost");
ViewOptions viewOptions = new ViewOptions();
viewOptions.setFileInfo(fileInfo);
viewOptions.setViewFormat(ViewFormatEnum.HTML);
HtmlOptions renderOptions = new HtmlOptions();
OutlookOptions outlookOptions = new OutlookOptions();
outlookOptions.setTextFilter("Microsoft");
outlookOptions.setAddressFilter("susan");
renderOptions.setOutlookOptions(outlookOptions);
viewOptions.setRenderOptions(renderOptions);

ViewResult response = apiInstance.createView(new CreateViewRequest(viewOptions));

    # For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-ruby-samples
require 'groupdocs_viewer_cloud'

$client_id = "XXXX-XXXX-XXXX-XXXX" # Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
$client_secret = "XXXXXXXXXXXXXXXX" # Get Client Id and Client Secret from https://dashboard.groupdocs.cloud

apiInstance = GroupDocsViewerCloud::ViewApi.from_keys($client_id, $client_secret)

viewOptions = GroupDocsViewerCloud::ViewOptions.new
viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
viewOptions.file_info.file_path = "SampleFiles/sample.ost"
viewOptions.view_format = "HTML"
viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
viewOptions.render_options.outlook_options = GroupDocsViewerCloud::OutlookOptions.new
viewOptions.render_options.outlook_options.text_filter = "Microsoft"
viewOptions.render_options.outlook_options.address_filter = "susan"

request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)
response = apiInstance.create_view(request)

    // For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-node-samples
global.viewer# require("groupdocs-viewer-cloud");

global.clientId = "XXXX-XXXX-XXXX-XXXX"; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
global.clientSecret = "XXXXXXXXXXXXXXXX"; // Get Client Id and Client Secret from https://dashboard.groupdocs.cloud

global.viewApi = viewer_cloud.ViewApi.fromKeys(clientId, clientSecret);

let fileInfo = new viewer_cloud.FileInfo();
fileInfo.filePath = "SampleFiles/sample.ost";
let viewOptions = new viewer_cloud.ViewOptions();
viewOptions.fileInfo = fileInfo;
viewOptions.viewFormat = viewer_cloud.ViewOptions.ViewFormatEnum.HTML;
viewOptions.renderOptions = new viewer_cloud.HtmlOptions();
viewOptions.renderOptions.outlookOptions = new viewer_cloud.OutlookOptions();
viewOptions.renderOptions.outlookOptions.textFilter = "Microsoft";
viewOptions.renderOptions.outlookOptions.addressFilter = "susan";

let request = new viewer_cloud.CreateViewRequest(viewOptions);
let response = await viewApi.createView(request);

    # For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-python-samples
import groupdocs_viewer_cloud

client_id = "XXXX-XXXX-XXXX-XXXX" # Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
client_secret = "XXXXXXXXXXXXXXXX" # Get Client Id and Client Secret from https://dashboard.groupdocs.cloud

apiInstance = groupdocs_viewer_cloud.ViewApi.from_keys(client_id, client_secret)

view_options = groupdocs_viewer_cloud.ViewOptions()
view_options.file_info = groupdocs_viewer_cloud.FileInfo()
view_options.file_info.file_path = "SampleFiles/sample.ost"
view_options.view_format = "HTML"
view_options.render_options = groupdocs_viewer_cloud.HtmlOptions()
view_options.render_options.outlook_options = groupdocs_viewer_cloud.OutlookOptions()
view_options.render_options.outlook_options.text_filter = "Microsoft"
view_options.render_options.outlook_options.address_filter = "susan"

request = groupdocs_viewer_cloud.CreateViewRequest(view_options)
response = apiInstance.create_view(request)

    package RenderingOutlookDataFiles

import (
    "fmt"

    "github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-go-samples/config"
    viewer "github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-go/models"
)

// This example demonstrates how to render Outlook Data File with filtering the rendered messages
func FilterMessages() {
    viewOptions := viewer.ViewOptions{
        FileInfo: &viewer.FileInfo{
            FilePath: "SampleFiles/sample.ost",
        },
        ViewFormat: viewer.ViewFormatHtml,
        RenderOptions: &viewer.HtmlOptions{
            OutlookOptions: &viewer.OutlookOptions{
                TextFilter:    "Microsoft",
                AddressFilter: "susan",
            },
        },
    }

    response, _, err := config.Client.ViewApi.CreateView(config.Ctx, viewOptions)
    if err != nil {
        fmt.Printf("Exception: %v\n", err)
        return
    }

    fmt.Printf("FilterMessages completed: %v pages\n", len(response.Pages))
}

    On this page

    Close
    Loading

    Analyzing your prompt, please hold on...

    An error occurred while retrieving the results. Please refresh the page and try again.

    © GroupDocs 2001-2025. All Rights Reserved.