Introduction to the Pop3ClientDataProvider Module

The Pop3ClientDataProvider module provides a data provider API for POP3 servers.

This data provider provides Pop3Client API access to:

List available messages on the server (with sizes and UIDLs)
Retrieve specific messages by ID
Retrieve message headers only (more efficient)
Get message metadata and content
Query server capabilities
Get unique message identifiers (UIDL)

Pop3Client Data Provider Factory

The name of the Pop3Client data provider factory is pop3.

Data Provider Structure

The data provider has the following structure:

pop3/ - Root data provider
- list - List messages (supports request returning message info with UIDLs)
  - {id}/ - Individual message provider
    - get - Retrieve full message
    - headers - Retrieve headers only (uses TOP command)
- capabilities - Get server capabilities (CAPA command)
- uidl - Get unique message identifiers

Pop3Client Data Provider Examples

These examples are with qdp, the command-line interface to the Data Provider API, and additionally assume that there is an available connection called pop3client, which has been fully authorized with OAuth2 to access Pop3Client on behalf of the user.

API Example: List Available Messages with UIDLs

qdp pop3client/list

API Example: Retrieve a Specific Message

qdp pop3client/list/1/get

API Example: Retrieve Only Message Headers

qdp pop3client/list/1/headers

API Example: Get Server Capabilities

qdp pop3client/capabilities

API Example: Get Unique Message IDs

qdp pop3client/uidl

Release Notes

Pop3ClientDataProvider v2.1

Added capabilities endpoint for CAPA command (RFC 2449)
Added uidl endpoint for UIDL command
Added headers endpoint for efficient header-only retrieval (TOP command)
Enhanced list endpoint to return message sizes and UIDLs via request

Pop3ClientDataProvider v2.0

updated for new data provider API

Pop3ClientDataProvider v1.0

initial release of the module

Table of Contents