Qore Pop3Client Module Reference  1.9
Pop3Client::Pop3Connection Class Reference

class for POP3 connections; returns an object of class Pop3Client for receiving or polling for emails More...

Inheritance diagram for Pop3Client::Pop3Connection:

Public Member Methods

 constructor (string name, string description, string url, hash attributes={}, hash options={})
 creates the RestConnection connection object More...
 
*hash< auto > getRuntimeOptions ()
 returns runtime options More...
 
string getType ()
 returns "pop3"
 

Public Attributes

const ConnectionScheme
 Connection entry info.
 

Private Member Methods

hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 
Pop3Client getImpl (bool connect=True, *hash rtopts)
 returns a Pop3Client object More...
 

Detailed Description

class for POP3 connections; returns an object of class Pop3Client for receiving or polling for emails

supports the following runtime options in getImpl() for connection logging:

  • "log": a closure accepting a single string for logging
  • "dbglog": a closure taking a single string for detailed technical connection logging
Since
Pop3Client 1.5

Member Function Documentation

◆ constructor()

Pop3Client::Pop3Connection::constructor ( string  name,
string  description,
string  url,
hash  attributes = {},
hash  options = {} 
)

creates the RestConnection connection object

Parameters
namethe name of the connection
descriptionconnection description
urlconnection URL (potentially with password info)
attributesvarious attributes. See below
optionsconnection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option

◆ getImpl()

Pop3Client Pop3Client::Pop3Connection::getImpl ( bool  connect = True,
*hash  rtopts 
)
private

returns a Pop3Client object

Parameters
connectif True, then Pop3Client::Pop3Client::connect() is called
rtoptssupports the following runtime options in getImpl() for connection logging:
  • "log": a closure accepting a single string for logging
  • "dbglog": a closure taking a single string for detailed technical connection logging
Returns
a Pop3Client object

◆ getRuntimeOptions()

*hash<auto> Pop3Client::Pop3Connection::getRuntimeOptions ( )

returns runtime options

Returns
a hash with the following keys reflecting support for the corresponding runtime options in getImpl() for connection logging:
  • "log": a closure accepting a single string for logging
  • "dbglog": a closure taking a single string for detailed technical connection logging