#include <SFBPimMessageStore.h.hpp>

class SFBPimMessageStore : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBPimMessageStore)

[ public ]
SFCError AddFolder(
    ACharConstPtr attribute   // null-terminated folder attribute string
    MsgFolderIDPtr folderID   // assigned FolderID for the newly created folder
);

[ public ]
SFCError AddFolder(
    SFXAnsiStringConstRef attribute   // folder attribute string
    MsgFolderIDPtr folderID           // assigned FolderID for the newly created folder
);

[ public ]
SFCError AddMsg(
    UInt08ConstPtr message    // pointer to the buffer storing the OTA message
    SInt32 length             // the length of the message buffer in byte
    ACharConstPtr attribute   // null-terminated message attribute string
    MessageIDPtr msgID        // message ID assigned to the new meesage that can be used to identify the message later
);

[ public ]
SFCError AddMsg(
    SFXBufferConstRef message         // the buffer storing the OTA message
    SFXAnsiStringConstRef attribute   // message attribute string
    MessageIDPtr msgID                // message ID assigned to the new meesage that can be used to identify the message later
);

[ public ]
SFCError DeleteFolder(
    MsgFolderID folderID   // folder ID identifying the folder to be deleted
);

[ public ]
SFCError DeleteMsg(
    MessageID msgID   // message ID identifying the meesage to be deleted
);

[ public ]
SFCError GetFolderInfo(
    MsgFolderID folderID   // folder ID to identify the folder
    ACharPtr attribute     // pointer to a buffer used to store the requested folder attribute string
    SInt32 attrLen         // the size of the buffer
    SInt32Ptr attrLenreq   // the required size to store the entire folder attribute string
);

[ public ]
SFCError GetFolderInfo(
    MsgFolderID folderID         // folder ID to identify the folder
    SFXAnsiStringPtr attribute   // buffer used to store the requested folder attribute string
);

[ public ]
SFCError GetMsgIDsbyFolder(
    MsgFolderID folderID     // unique folder ID identifing the folder
    MessageIDPtr msgIDs      // pointer to an array of MessageID storing the IDs of the messages in the specified folder
    SInt32 msgIDsLen         // the length (number of the elements) in the array
    SInt32Ptr msgIDsLenreq   // required array length to store all the returned message IDs
);

[ public ]
SFCError GetSubFolderIDs(
    MsgFolderID folderID           // folder ID to identify the folder
    MsgFolderIDPtr subFolderIDs    // array of MsgFolderID to store the subfolder IDs
    SInt32 subFolderIDsLen         // number of the elements in array
    SInt32Ptr subFolderIDsLenreq   // required minimum array elements to store all the subfolder IDs in the folder
);

[ public ]
SFCError GetSupportedFolderAttrs(
    ACharPtr attribute     // null-terminated key-value pair attribute string
    SInt32 attrStrLen      // the length of the attribute string buffer
    SInt32Ptr attrLenreq   // the required length to store the entire attribute string
);

[ public ]
SFCError GetSupportedFolderAttrs(
    SFXAnsiStringPtr attribute   // key-value pair attribute string
);

[ public ]
SFCError GetSupportedMsgAttrs(
    ACharPtr attribute     // null-terminated key-value pair attribute string
    SInt32 attrLen         // the length of the attribute string buffer
    SInt32Ptr attrLenreq   // the required length to store the entire attribute string
);

[ public ]
SFCError GetSupportedMsgAttrs(
    SFXAnsiStringPtr attribute   // key-value pair attribute string
);

[ public, static ]
SFBPimMessageStoreSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBPimMessageStoreSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

[ public ]
SFCError ReadMsg(
    MessageID msgID        // message ID to identify the message in the store
    UInt08Ptr message      // pointer to a buffer used to store the message in OTA format
    SInt32 msgLen          // length of the message buffer in byte
    SInt32Ptr msgLenreq    // the required buffer length to store the entire OTA message
    ACharPtr attribute     // pointer to the attribute string buffer
    SInt32 attrLen         // the size of the attribute string buffer
    SInt32Ptr attrLenreq   // the required size to store the entire attribute string
);

[ public ]
SFCError ReadMsg(
    MessageID msgID              // message ID to identify the message in the store
    SFXBufferPtr message         // a buffer used to store the message in OTA format
    SFXAnsiStringPtr attribute   // the attribute string buffer
);

[ public ]
SFCError UpdateFolder(
    MsgFolderID folderID      // unique identifier for the folder that needs to be updated
    ACharConstPtr attribute   // new folder attribute string
);

[ public ]
SFCError UpdateFolder(
    MsgFolderID folderID              // unique identifier for the folder that needs to be updated
    SFXAnsiStringConstRef attribute   // new folder attribute string
);

[ public ]
SFCError UpdateMsg(
    MessageID msgID           // message ID to identify the message to be updated. 
    UInt08ConstPtr message    // pointer to the message buffer storing the new OTA message
    SInt32 msgLen             // the length of the message buffer in byte
    ACharConstPtr attribute   // new attribute stirng
);

[ public ]
SFCError UpdateMsg(
    MessageID msgID                   // message ID to identify the message to be updated. 
    SFXBufferConstRef message         // the message buffer storing the new OTA message
    SFXAnsiStringConstRef attribute   // new attribute stirng
);

enum AliasEnum {
    EBASE               = pim_IMessageStore_EBASE,
    EINVALIDMSGID       = pim_IMessageStore_EINVALIDMSGID,
    EINVALIDFOLDERID    = pim_IMessageStore_EINVALIDFOLDERID,
    FOLDER_ID_ROOT      = pim_IMessageStore_FOLDER_ID_ROOT
};
SFMTYPEDEFTYPE(AliasEnum)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_FolderAttrStr, FolderAttrStr)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_Message, Message)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_MessageID, MessageID)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_MessageIDs, MessageIDs)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_MsgAttrStr, MsgAttrStr)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_MsgFolderID, MsgFolderID)

SFMTYPEDEFALIAS(pim_IMessageStoreUtil_MsgFolderIDs, MsgFolderIDs)