Qore SmtpClient Module Reference 2.0
Loading...
Searching...
No Matches
SmtpClientSendEmailDataProvider Class Reference

Send email data provider. More...

#include <SmtpClient.qm.dox.h>

Inherits AbstractDataProvider.

Public Member Methods

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (SmtpClient smtp)
 Creates the object from an SMTP connection.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

const ProviderInfo = ...
 Provider info.
 
const ProviderSummaryInfo = ...
 Provider summary info.
 
const RequestType = new SmtpSendEmailRequestDataType()
 Request type.
 
const ResponseType = SmtpSendEmailResponseDataType
 Response type.
 
SmtpClient smtp
 SMTP connection.
 

Private Member Methods

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response.
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any.
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message.
 

Detailed Description

Send email data provider.

Member Function Documentation

◆ doRequestImpl()

auto SmtpClientSendEmailDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
private

Makes a request and returns the response.

Parameters
reqthe request info
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType SmtpClientSendEmailDataProvider::getRequestTypeImpl ( )
private

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType SmtpClientSendEmailDataProvider::getResponseTypeImpl ( )
private

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message