SmtpClient::SmtpConnection Class Reference

class for SMTP connections; returns an object of class SmtpClient for sending emails More...

Inheritance diagram for SmtpClient::SmtpConnection:

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: creates the SmtpConnection object. More...
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the SmtpConnection connection object More...
*hash< auto >	getRuntimeOptions ()
	returns runtime options More...
string	getType ()
	returns "smtp"

Static Public Member Methods
static deprecated SmtpConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: static constructor. More...

Private Member Methods
SmtpClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns an SmtpClient object More...

Detailed Description

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

Since

SmtpClient 1.6

Member Function Documentation

constructor() [1/2]

deprecated SmtpClient::SmtpConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

DEPRECATED: creates the SmtpConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Deprecated:

since Qore 0.9

constructor() [2/2]

SmtpClient::SmtpConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the SmtpConnection connection object

Parameters

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.

getImpl()

SmtpClient SmtpClient::SmtpConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

privatevirtual

returns an SmtpClient object

Parameters

connect	if True, then SmtpClient::connect() is called
rtopts	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

Returns

an SmtpClient object

Implements ConnectionProvider::AbstractConnection.

getRuntimeOptions()

*hash<auto> SmtpClient::SmtpConnection::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

make()

static deprecated SmtpConnection SmtpClient::SmtpConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash  opts, hash  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection