TransportRecvEx
This function, an extension of TransportRecv, receives messages from not only the mail server, but also any specified folder on the mail server as well.
At a Glance
Header file: |
Msgstor2.h |
Platforms: |
H/PC 3.0 |
Windows CE versions: |
2.10 and later |
Syntax
BOOL TransportRecvEx(HANDLE hService, LPWSTR szFolderID,
WORD wMsgID, short sNumLines, MailMsg *MsgPtr,
lpMailAttArray *lplMaa);
Parameters
- hService
- [in] Handle to a private SERVICE structure.
- szFolderID
- [in] Null-terminated string that contains the identifier of the folder in which the message originates.
- wMsgID
- [in] Specifies the identifier of the message for this session. It is either 0 or in the range from 1 to the number of messages returned by the function TransportCountEx. If wMsgID is 0, this function uses the szSvcId member of the MailMsg structure pointed to by MsgPtr instead.
- sNumLines
- [in] Specifies the number of lines of the message to receive. This function fills MailMsg with the message header values, the number of lines from the message body as specified in sNumLines, and any attachment header values. It can also be one of the following values:
- TRANSPORT_MSG_EXIST
- Checks for the message described in wMsgID. If this message exists, this function returns the message service identifier in the scSvcId member of MailMsg.
- TRANSPORT_HEADERS
- Parses the message header and places the information in MsgPtr, and returns attachment header information in the lplpMaa parameter.
- TRANSPORT_ALL_LINES
- Returns the full message, including headers and body text, in MailMsg, as well as all attachments through lplpMaa, subject to the user’s preference. If the user has turned off the download attachment option, this function returns only the attachment header information.
- MsgPtr
- [in/out] Pointer to a MailMsg structure that receives the message information. The szSvcID member of MailMsg specifies the service identifier of the message to be received.
- lplpMaa
- [in] Long pointer to the long pointer to a MailAttArray structure, which contains any attachments the message may have.
Return Values
TRUE indicates success. FALSE indicates failure. To get extended error information, call the function TransportError or TransportErrorMsg.
Remarks
The transport service provider must implement this function in a DLL registered as a mail service. The Inbox application can then load this DLL and call this function.