TransportDel

This function deletes a specific message located on the mail server.

At a Glance

Syntax

BOOL TransportDelete(HANDLE hService, MailMsg *MsgPtr);

Parameters

hService

[in] Handle to a SERVICE structure.

MsgPtr

[in] Pointer to the MailMsg structure. The szSvcID member of the MailMsg structure specifies the service identifier of the message to be deleted.

This member is compared with the message identifiers stored in the Uids member of the specified SERVICE structure. The information maintained in hService is then used in support of deleting the message. 

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call TransportError or TransportErrorMsg. For example, if the message identifier cannot be found, the iErr member of the specified MailMsg structure is set to TRANS_ERR_INV_MSG_ID.

Remarks

The transport service provider must implement the TransportDel function in a DLL registered as a mail service. The Inbox application can then load this DLL and call this function.

For the sample service, TransportDel removes the file specified in the MsgPtr structure.