![]() |
Qore SmtpClient Module Reference 2.0
|
class for SMTP connections; returns an object of class SmtpClient for sending emails More...
Public Member Functions | |
| constructor (hash< auto > config, *hash< auto > attr) | |
| creates the SmtpConnection connection object | |
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) | |
| creates the SmtpConnection connection object | |
| DataProvider::AbstractDataProvider | getDataProvider (*hash< auto > constructor_options) |
| returns an SmtpClientDataProvider object for this connection | |
| *hash< auto > | getRuntimeOptions () |
| returns runtime options | |
| string | getType () |
returns "smtp" | |
| bool | hasDataProvider () |
| returns True, as the connection returns a data provider with the getDataProvider() method | |
| Qore::AbstractPollOperation | startPollConnect (*Logger::LoggerInterface logger) |
| Called to start a non-blocking polling ping operation on the remote SMTP server. | |
| bool | supportsPollingApi () |
| returns True, since this connection type supports the Qore Socket-based polling API | |
Public Attributes | |
| const | ConnectionScheme = ... |
| Connection entry info. | |
Protected Member Functions | |
| hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
| Returns the ConnectionSchemeInfo hash for this object. | |
| SmtpClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns an SmtpClient object | |
| setChildCapabilities () | |
| Sets child data provider capabilities. | |
class for SMTP connections; returns an object of class SmtpClient for sending 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| SmtpConnection::constructor | ( | hash< auto > | config, |
| *hash< auto > | attr ) |
creates the SmtpConnection connection object
| config | with the following keys:
|
| attr | optional connection attributes
|
| CONNECTION-OPTION-ERROR | missing or invalid connection option or attribute |
| SmtpConnection::constructor | ( | string | name, |
| string | description, | ||
| string | url, | ||
| hash< auto > | attributes = {}, | ||
| hash< auto > | options = {} ) |
creates the SmtpConnection connection object
| name | the name of the connection |
| description | connection description |
| url | connection URL (potentially with password info) |
| attributes | various attributes. See below |
| options | connection options |
See AbstractConnection::constructor() for attributes and options reference.
| CONNECTION-OPTION-ERROR | missing or invalid connection option |
| DataProvider::AbstractDataProvider SmtpConnection::getDataProvider | ( | *hash< auto > | constructor_options | ) |
returns an SmtpClientDataProvider object for this connection
| constructor_options | any additional constructor options for the data provider |
|
protected |
returns an SmtpClient object
| connect | if True, then SmtpClient::connect() is called |
| rtopts | supports the following runtime options in getImpl() for connection logging:
|
| *hash< auto > SmtpConnection::getRuntimeOptions | ( | ) |
returns runtime options
"log": a closure accepting a single string for logging"dbglog": a closure taking a single string for detailed technical connection logging | bool SmtpConnection::hasDataProvider | ( | ) |
returns True, as the connection returns a data provider with the getDataProvider() method
| Qore::AbstractPollOperation SmtpConnection::startPollConnect | ( | *Logger::LoggerInterface | logger | ) |
Called to start a non-blocking polling ping operation on the remote SMTP server.
| bool SmtpConnection::supportsPollingApi | ( | ) |
returns True, since this connection type supports the Qore Socket-based polling API