MailRequestAttachment

The MailRequestAttachment function requests a non-local attachment to a service-linked message for download, if the service allows that.

Syntax

BOOL MailRequestAttachment (HANDLE hMail, MailMsg * pmm, MailAtt * pma, BOOL bRetrieve);

At a Glance

Parameters

hMail

Handle to the current mail context. This handle is created by the MailOpen function.

pmm

Pointer to the mail message to which the attachment belongs.

pma

Pointer to the mail attachment being requested. The caller must specify the uiAttachment member field to identify the number of the requested attachment.

bRetrieve

Request to download the attachment when this flag is TRUE. Otherwise, cancel the earlier request.

Return Values

This function returns TRUE if the request is successful; FALSE otherwise. If a service does not allow individual download, the function returns FALSE also.

Remarks

If the request is successful, download will be started next time when the mail client is connected to a server.

To get extended error information, use MailError or MailErrorMsg.