Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 1.58 KB

MAPIReadMail.md

File metadata and controls

74 lines (52 loc) · 1.58 KB

Home

Function name : MAPIReadMail

Group: Simple MAPI - Library: mapi32

The MAPIReadMail function retrieves a message for reading.

Code examples:

How to read email messages using Simple MAPI

Declaration:

ULONG FAR PASCAL MAPIReadMail(
  LHANDLE lhSession,
  ULONG ulUIParam,
  LPTSTR lpszMessageID,
  FLAGS flFlags,
  ULONG ulReserved,
  lpMapiMessage FAR * lppMessage
)

FoxPro declaration:

DECLARE INTEGER MAPIReadMail IN mapi32;
	INTEGER   lhSession,;
	INTEGER   ulUIParam,;
	STRING    lpszMessageID,;
	INTEGER   flFlags,;
	INTEGER   ulReserved,;
	INTEGER @ lppMessage

Parameters:

lhSession [in] Handle to a Simple MAPI session.

ulUIParam [in] Parent window handle or zero, indicating that if a dialog box is displayed, it is application modal.

lpszMessageID [in] Pointer to a message identifier string for the message to be read.

flFlags [in] Bitmask of option flags.

ulReserved Reserved; must be zero.

lppMessage [out] Pointer to the location where the message is written.

Return value:

SUCCESS_SUCCESS (0) or an error code.

Comments:

Before calling MAPIReadMail, use the MAPIFindNext function to verify that the message to be read is the one you want to be read.

Messages are written to a MapiMessage structure which can be freed with a single call to the MAPIFreeBuffer function.