$allowpathinuri | If true,the SMTP worker allows path in URI |
$alwaysfinish | If true,the worker allows an asynchronous request to run to completion even if the instance containing the worker closes |
$callbackinst | The instance to which the worker object sends messages,for example when its processing has completed or has been cancelled.If you do not assign an instance to $callbackinst the worker object sends messages to itself |
$callmailshotprogress | If true,and the worker is sending a mailshot asynchronously via $start,the worker generates notifications to $mailshotprogress as it executes.Defaults to false |
$callprogress | If true,the worker periodically generates a notification to $progress as it executes.Defaults to false |
$curloptions | Use this property to set internal CURL options not otherwise exposed by the worker.A 2 column list,where column 1 is a number (the CURL easy option number) and column 2 is a string.The internal option must be an integer or string value |
$errorcode | Error code associated with the last action (zero means no error) |
$errortext | Error text associated with the last action (empty means no error) |
$keepconnectionopen | If true,the worker can leave the connection to the server open when it completes its request.Defaults to false.Note that even when this property is set to true,a protocol error may cause the connection to close |
$oauth2 | An object reference to an OAUTH2Worker object containing the authorization information required to make requests to the server.Clear this property by assigning #NULL to it.$authorize() cannot run while the OAUTH2Worker is assigned to $oauth2 |
$protocollog | If non-zero,the worker adds a log of protocol activity as a column named log to its wResults row.Defaults to kOW3logNone.Otherwise,a sum of kOW3log... constants |
$requiresecureconnection | If true,and the URI is not a secure URI,the connection starts as a non-secure connection which must be upgraded to a secure connection (using STARTTLS or STLS).If it cannot be upgraded then the request fails.Defaults to false |
$state | A kWorkerState... constant that indicates the current state of the worker object kWorkerStateCancelled kWorkerStateClear kWorkerStateComplete kWorkerStateInit kWorkerStateRunning |
$threadcount | The number of active background threads for all instances of this type of worker object |
$timeout | The timeout (in seconds) for requests.Zero means requests do not time out.For the OAUTH2Worker defaults to 60 with a minimum value of 10;otherwise,defaults to 10 with a minimum value of zero |
$cancel | $cancel() If required,cancels execution of worker on background thread.Will not return until the request has been cancelled |
$cancelled | $cancelled() Method called when the request has been cancelled |
$completed | $completed(wResults) Method called when the request completes.wResults is a row containing the results of executing the request |
$getsecureoptions | $getsecureoptions([&bVerifyPeer,&bVerifyHost,&cCertFile,&cPrivKeyFile,&cPrivKeyPassword]) gets the options that affect how secure connections are established (the options do not apply to SFTP) |
$init | $init(cURI,cUser,cPassword,vFrom,lTo,lCc,lBcc,cSubject,iPriority,lHeaders,vContent[,bMailshot=kFalse]) Initialise the object so it is ready to send the specified message using SMTP.Returns true if successful |
$mailshotprogress | $mailshotprogress(wInfo) Notification generated after each time the worker has attempted to send the message to a mailshot recipient |
$progress | $progress(wProgress) Method called during worker execution to report progress (see $callprogress property) |
$run | $run() Run worker on current thread.Returns true if the worker executed successfully |
$setsecureoptions | $setsecureoptions([bVerifyPeer=kTrue,bVerifyHost=kTrue,cCertFile='',cPrivKeyFile='',cPrivKeyPassword='']) sets the options that affect how secure connections are established (the options do not apply to SFTP) |
$start | $start() Run worker on background thread.Returns true if the worker was successfully started |