| $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 |
| $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 |
| $defaultcharset | Used by kOW3imapActionFetchMessage and kOW3pop3ActionGetMessage when there is no charset for a MIME text body part.The charset used to convert to character.Default kUniTypeUTF8.A kUniType... constant (not Character/Auto/Binary) kUniTypeAnsiArabic kUniTypeAnsiBaltic kUniTypeAnsiCentralEuropean kUniTypeAnsiCyrillic kUniTypeAnsiGreek kUniTypeAnsiHebrew kUniTypeAnsiLatin1 kUniTypeAnsiThai kUniTypeAnsiTurkish kUniTypeAnsiVietnamese kUniTypeISO8859_1 kUniTypeISO8859_10 kUniTypeISO8859_11 kUniTypeISO8859_13 kUniTypeISO8859_14 kUniTypeISO8859_15 kUniTypeISO8859_16 kUniTypeISO8859_2 kUniTypeISO8859_3 kUniTypeISO8859_4 kUniTypeISO8859_5 kUniTypeISO8859_6 kUniTypeISO8859_7 kUniTypeISO8859_8 kUniTypeISO8859_9 kUniTypeNativeCharacters kUniTypeOEM kUniTypeUTF16 kUniTypeUTF16BE kUniTypeUTF16LE kUniTypeUTF32 kUniTypeUTF32BE kUniTypeUTF32LE kUniTypeUTF8 |
| $errorcode | Error code associated with the last action (zero means no error) |
| $errortext | Error text associated with the last action (empty means no error) |
| $ignoreflags | If true,the worker ignores errors in parsing the FLAGS from a server response. Defaults to false |
| $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 |
| $removemessageid | If true,the worker removes the Message-id header from the message when performing kOW3imapActionAppendMessage. Defaults to true |
| $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 |
| $splitfetchedmessage | If true,worker splits fetched message into headers and MIME list for any content.Defaults to true.If false,the worker simply returns the raw fetched message data (Applies to kOW3imapActionFetchMessage and kOW3pop3ActionGetMessage) |
| $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 |
| $chartoutf7 | $chartoutf7(cChar) Returns a binary value (containing 7 bit characters) that is the IMAP UTF-7 representation of cChar |
| $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,iAction,cMailboxName,vParam1,vParam2) Initialise the object so it is ready to perform the specified action using IMAP.Returns true if successful |
| $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 |
| $utf7tochar | $utf7tochar(xUtf7[,bAllowCRLF=kTrue]) Converts IMAP UTF-7 xUtf7 to character and returns the result. Optionally allows CRLF sequences in the data and replaces them with CR in the result |