ProcessQueue Method

Sends the messages which have previously been queued into QueueDir .

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ProcessQueue(const char* lpszQueueDir);

Unicode (Windows)
INT ProcessQueue(LPCWSTR lpszQueueDir);

- (void)processQueue:(NSString*)queueDir;

#define MID_PHTMLMAILER_PROCESSQUEUE 9

IPWORKSOPENPGP_EXTERNAL int IPWORKSOPENPGP_CALL IPWorksOpenPGP_PHTMLMailer_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method sends the messages which have previously been queued into QueueDir. The PITrail event shows the interaction with the server as messages as are processed.

This method looks in the directory for files with extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the KeepQueue configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)