POP3 Reader Input Adapter Sample

This sample demonstrates how to use the TIBCO StreamBase® Input Adapter for IP/POP3.

Note

This adapter uses the WinPcap libraries for Windows to tap into the IP packet stream. Before using this adapter with real-time data, you must install and configure these libraries on the system that will host the adapter.

Download and install the latest WinPcap MSI from http://www.winpcap.org. Use all the default settings for the installation. This adapter is not supported on Mac OS X or Linux.

Running This Sample in StreamBase Studio

  1. In the Package Explorer, double-click to open the POP3Reader.sbapp application. Make sure the application is the currently active tab in the EventFlow Editor.

  2. Click the Run button. This opens the SB Test/Debug perspective and starts the application.

  3. Use a mail client to retrieve a message from a POP3 server.

  4. In the Application Output view, observe that a tuple is emitted through the POP3ReaderOutput stream.

  5. When done, press F9 or click the Stop Running Application button.

Running This Sample in Terminal Windows

This section describes how to run the sample in UNIX terminal windows or Windows command prompt windows. On Windows, be sure to use the StreamBase Command Prompt from the Start menu as described in the Test/Debug Guide, not the default command prompt.

  1. Open two terminal windows on UNIX, or two StreamBase Command Prompts on Windows. In each window, navigate to the directory where the sample is installed, or to your workspace copy of the sample, as described above.

  2. In window 1, type: sbd POP3Reader.sbapp.

  3. In window 2, start a dequeuer by typing: sbc dequeue POP3ReaderOutput.

  4. Use a mail client to retrieve a message from a POP3 server.

  5. A tuple representing the e-mail message appears in window 2.

  6. In window 2, type: Ctrl+C to exit the sbc session.

  7. In window 2, type the following command to terminate the server and dequeuer:

    sbadmin shutdown

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top menu, click FileLoad StreamBase Sample.

  • Select this sample from the Embedded Adapters list.

  • Click OK.

StreamBase Studio creates a single project containing the sample files.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

studio-workspace/sample_adapter_embedded_pop3reader

See Default Installation Directories for the default location of studio-workspace on your system.

In the default TIBCO StreamBase installation, this sample's files are initially installed in:

streambase-install-dir/sample/adapter/embedded/pop3reader

See Default Installation Directories for the default location of studio-workspace on your system.