Pop3Client Module Introduction

The Pop3Client module provides the Pop3Client class for retrieving emails from a POP3 server, with or without TLS/SSL encryption.

To use this module, use "%requires Pop3Client" in your code. See examples/pop3.q for an example program using this module.

All the public symbols in the module are defined in the Pop3Client namespace.

The main classes are:

Pop3Client: provides an interface to a POP3 server for retrieving emails
Pop3Connection: provides a connection object to a POP3 server (based on the ConnectionProvider module)

Example:: //!/usr/bin/env qore

%modern

%requires Pop3Client

Logger logger("console", LoggerLevel::INFO);

logger.addAppender(new ConsoleAppender());

string url = "pop3s://username:pass@pop.gmail.com";

Pop3Client pop3(url, {"logger": logger});

# do not send a QUIT so changes will not be committed

pop3.noquit(True);

*hash<auto> h = pop3.getMail();

printf("Mailbox Summary:\n");

map printf("%s: From: %s (size: %d bytes, attachments: %d)\n", $1.key, $1.value.msg.getFrom(), $1.value.size, $1.value.msg.getAttachments().size()), h.pairIterator();

if (!h) {

printf("no messages\n");

}

Pop3Client Module Release Notes

Added non-blocking ping support using the Qore polling API:
- Pop3Connection::supportsPollingApi(): returns True
- Pop3Connection::startPollConnect(): starts a non-blocking ping operation
- Pop3PingPollOperation: state machine class for non-blocking POP3 connection, authentication, and ping
Added Pop3Client::getInfo(): returns connection info for polling operations
Added support for RFC 2449 CAPA (capability) command:
- Pop3Client::capa(): retrieve server capabilities
- Pop3Client::hasCapability(): check for a specific capability
- Pop3Client::clearCapabilities(): clear cached capabilities
Added support for optional POP3 commands:
- Pop3Client::uidl(): get unique IDs for messages (RFC 1939)
- Pop3Client::top(): retrieve message headers and partial body (RFC 1939)
- Pop3Client::getMessageHeaders(): get parsed message headers
Now requires Qore >= 2.0, Mime >= 1.7, and MailMessage >= 1.5
Fixed typo in documentation example
Fixed incorrect log message in SASL XOAUTH2 login (issue 5163)

implemented support for a data provider scheme cache and rich option information for connections (issue 4025)

removed the Pop3Connection::getConstructorInfo() and Pop3Connection::getConstructorInfoImpl() methods (issue 3696)
added support for socket events (issue 3425)

added the Pop3Connection::getConstructorInfo() method to allow connections to be created dynamically, potentially in another process from a network call (removed in Pop3Client 1.8) (issue 2628)