TCPIP_SMTPC_MessageQuery Function

C

TCPIP_SMTPC_MESSAGE_RESULT TCPIP_SMTPC_MessageQuery(
    TCPIP_SMTPC_MESSAGE_HANDLE messageHandle, 
    TCPIP_SMTPC_MESSAGE_QUERY* pQuery
);

Description

This function allows the query of a mail message at run time.

Preconditions

SMTPC module should have been initialized.

Parameters


Parameters	Description
messageHandle	Handle identifying the message. This handle was obtained with a call to TCPIP_SMTPC_MailMessage().
pQuery	Pointer to a TCPIP_SMTPC_MESSAGE_QUERY() structure that will be updated with the current status of the mail message.

Returns

TCPIP_SMTPC_RES_OK - If message query updated successfully.
TCPIP_SMTPC_RES_MESSAGE_ERROR - If no such message exists.

Remarks

The message status is for info purposes only. The message status changes as is processed by the SMTPC module.

Once the mail transfer is complete and the corresponding notification function is called, the messageHandle is no longer valid and should not be used again.