Dacons LLP Mailit for C/C++ Version 1.0.8

Emai::MessageInfoList Class Reference

EmaiPop3MessageInfoList wrapper class. More...

#include <EmaiPOP3.hpp>

Inheritance diagram for Emai::MessageInfoList:

Emai::Object< EmaiPop3MessageInfoList > List of all members.

Public Member Functions

 MessageInfoList (EmaiConstUniCharPtr inFullFilePath, EmaiOptions inOptions=EmaiNullOptions)
 MessageInfoList (const void *inMessageListData, EmaiUint32 inMessageListDataSize, EmaiOptions inOptions=EmaiNullOptions)
 ~MessageInfoList ()
void EvaluateSublist (EmaiUint32 inDays, EmaiOptions inOptions=EmaiMessagesForDownload)
EmaiUint32 GetCount (EmaiOptions inOptions=EmaiMessagesForDownload)
 Returns the number of information records, stored at the message info list.
void GetInfo (EmaiUint32 inMessageIndex, EmaiMessageInfo &outInfo, EmaiOptions inOptions=EmaiMessagesForDownload)
 Retrives information record stored at the particular index of the message info list.
void MarkMessageReceived (EmaiUint32 inMessageIndex, EmaiOptions inOptions=EmaiMessageIndexInList)
 Marks the message at the specified index as "received", and saves it's info in the message history. This function will fail, if current sublist is not EmaiMessagesForDownload.
void GetMessageInfoListData (const void **outData, EmaiUint32 &outDataSize, EmaiOptions inOptions=EmaiNullOptions)
 Retrives message info list data.
void ResetInfoList (EmaiConstUniCharPtr inAccount, EmaiConstUniCharPtr inServer, EmaiOptions inOptions=EmaiNullOptions)
 Reset message info list.

Protected Types

typedef Object< EmaiPop3MessageInfoList > Parent

Protected Member Functions

 MessageInfoList ()
 no implementation
 MessageInfoList (const MessageInfoList &)
 no implementation

Detailed Description

EmaiPop3MessageInfoList wrapper class.

Definition at line 87 of file EmaiPOP3.hpp.


Member Function Documentation

EmaiUint32 Emai::MessageInfoList::GetCount ( EmaiOptions  inOptions = EmaiMessagesForDownload  )  [inline]

Returns the number of information records, stored at the message info list.

Parameters:
inOptions - EmaiLocalMessages, EmaiRemoteMessages etc
Returns:
Number of information records, stored at the message info list

Definition at line 448 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3MessageInfoListGetCount(), and Emai::Object< EmaiPop3MessageInfoList >::mObject.

00451 {
00452     EmaiUint32 count = 0;
00453     CheckErrorCode(EmaiPop3MessageInfoListGetCount(mObject,
00454                     &count, inOptions));
00455     return count;
00456 }

void Emai::MessageInfoList::GetInfo ( EmaiUint32  inMessageIndex,
EmaiMessageInfo outInfo,
EmaiOptions  inOptions = EmaiMessagesForDownload 
) [inline]

Retrives information record stored at the particular index of the message info list.

Parameters:
inMessageIndex - zero-based index of the record
outInfo - pointer to the EmaiMessageInfo structure, which is filled with message information, on successful function exit
inOptions - EmaiLocalMessages, EmaiRemoteMessages, etc.
See also:
EmaiMessageInfo

Definition at line 459 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3MessageInfoListGetInfo(), and Emai::Object< EmaiPop3MessageInfoList >::mObject.

00464 {
00465     CheckErrorCode(EmaiPop3MessageInfoListGetInfo(mObject,
00466                     inMessageIndex, &outInfo, inOptions));
00467 }

void Emai::MessageInfoList::MarkMessageReceived ( EmaiUint32  inMessageIndex,
EmaiOptions  inOptions = EmaiMessageIndexInList 
) [inline]

Marks the message at the specified index as "received", and saves it's info in the message history. This function will fail, if current sublist is not EmaiMessagesForDownload.

Parameters:
inMessageIndex - index of the message, actual interpretation of this parameter depends of the inOptions value, for more information see options value description
inOptions - EmaiMessageIndexInList or EmaiMessageIndexOnServer

Definition at line 470 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3MessageInfoMarkMessageReceived(), and Emai::Object< EmaiPop3MessageInfoList >::mObject.

00474 {
00475     CheckErrorCode(EmaiPop3MessageInfoMarkMessageReceived(mObject,
00476                     inMessageIndex, inOptions));
00477 }

void Emai::MessageInfoList::GetMessageInfoListData ( const void **  outData,
EmaiUint32 &  outDataSize,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Retrives message info list data.

Parameters:
outData - pointer to message info list data
outDataSize - message info list data size
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiMessageInfo

Definition at line 480 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3MessageInfoListGetHistoryData(), and Emai::Object< EmaiPop3MessageInfoList >::mObject.

00485 {
00486     CheckErrorCode(EmaiPop3MessageInfoListGetHistoryData(mObject,
00487                     outData, outDataSize, inOptions));
00488 }

void Emai::MessageInfoList::ResetInfoList ( EmaiConstUniCharPtr  inAccount,
EmaiConstUniCharPtr  inServer,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Reset message info list.

Parameters:
inAccount - reset account string
inServer - reset server string
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiMessageInfo

Definition at line 491 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3MessageInfoListResetHistory(), and Emai::Object< EmaiPop3MessageInfoList >::mObject.

00496 {
00497     CheckErrorCode(EmaiPop3MessageInfoListResetHistory(mObject,
00498                     inAccount, inServer, inOptions));
00499 }


The documentation for this class was generated from the following file: