store.h

Go to the documentation of this file.

/*  Copyright (c) 2004-2009, Isode Limited, London, England.
 *  All rights reserved.
 *                                                                       
 *  Acquisition and use of this software and related materials for any      
 *  purpose requires a written licence agreement from Isode Limited,
 *  or a written licence from an organisation licenced by Isode Limited
 *  to grant such a licence.
 *
 */
 
#ifndef _SOM_STORE_H
#define _SOM_STORE_H
 
#include "session.h"
#include "storeatt.h"
 
#define SOM_FACILITY_STORE (8) 
/* Object types */
 
struct SOMMSData;
struct SOMMSMailbox;
struct SOMMSConnection;
struct SOMMSMessage;
 
typedef void SOMMSStoreCallback (struct SOMSession *session,
                                 void *ophandle,
                                 void *clientdata,
                                 struct SOMMSData *data,
                                 int status,
                                 const char *errstring);
 
typedef void SOMMSStoreMonitorCallback (struct SOMSession *session,
                                        void *ophandle,
                                        void *clientdata,
                                        struct SOMMSData *data,
                                        int status,
                                        const char *datap,
                                        size_t dlen);
 
 
typedef void SOMMSStoreMailboxesCallback (struct SOMSession *session,
                                          void *ophandle,
                                          void *clientdata,
                                          struct SOMMSData *data,
                                          int status);
 
typedef void SOMMSStoreConnectionsCallback (struct SOMSession *session,
                                            void *ophandle,
                                            void *clientdata,
                                            struct SOMMSData *data,
                                            int status);
 
typedef void SOMMSStoreMessagesCallback (struct SOMSession *session,
                                         void *ophandle,
                                         void *clientdata,
                                         struct SOMMSData *data,
                                         int status);
 
typedef void SOMMSConnectionCallback (struct SOMSession *session,
                                      void *ophandle,
                                      void *clientdata,
                                      struct SOMMSConnection *con,
                                      int status);
 
 
typedef void SOMMSMailboxCallback (struct SOMSession *session,
                                   void *ophandle,
                                   void *clientdata,
                                   struct SOMMSMailbox *mbx,
                                   int status);
 
 
typedef void SOMMSMessageCallback (struct SOMSession *session,
                                   void *ophandle,
                                   void *clientdata,
                                   struct SOMMSMessage *message,
                                   int status);
 
SOMAPI_CDECL int SOMStoreSetMonitorCallback (struct SOMSession *session,
                                             SOMMSStoreMonitorCallback *callback,
                                             SOMMSStoreMonitorCallback **oldvalue);
 
SOMAPI_CDECL int SOMStoreSetCallback (struct SOMSession *session,
                                      SOMMSStoreCallback *callback,
                                      SOMMSStoreCallback **oldvalue);
 
 
SOMAPI_CDECL int 
SOMStoreSetListMailboxesCallback (struct SOMSession *session,
                                  SOMMSStoreMailboxesCallback *callback,
                                  SOMMSStoreMailboxesCallback **oldvalue);
 
SOMAPI_CDECL int 
SOMStoreSetListConnectionsCallback (struct SOMSession *session,
                                    SOMMSStoreConnectionsCallback *callback,
                                    SOMMSStoreConnectionsCallback **oldvalue);
 
SOMAPI_CDECL int 
SOMStoreSetListMessagesCallback (struct SOMSession *session,
                                 SOMMSStoreMessagesCallback *callback,
                                 SOMMSStoreMessagesCallback **oldvalue);
 
 
SOMAPI_CDECL int SOMStoreSetConnectionCallback (struct SOMSession *session,
                                                SOMMSConnectionCallback *callback,
                                                SOMMSConnectionCallback **oldvalue);
 
 
 
SOMAPI_CDECL int SOMStoreSetMailboxCallback (struct SOMSession *session,
                                             SOMMSMailboxCallback *callback,
                                             SOMMSMailboxCallback **oldvalue);
 
 
 
SOMAPI_CDECL int SOMStoreSetMessageCallback (struct SOMSession *session,
                                             SOMMSMessageCallback *callback,
                                             SOMMSMessageCallback **oldvalue);
 
 
/* \} */
 
SOMAPI_CDECL int SOMStoreGetStrParam (struct SOMSession *session,
                                      int paramtype,
                                      char *buffer,
                                      size_t buflen,
                                      size_t *paramlenp);
 
 
SOMAPI_CDECL int SOMStoreGetIntParam (struct SOMSession *session,
                                      int paramtype,
                                      int *valp);
 
SOMAPI_CDECL int SOMStoreConnectionGetStrParam (struct SOMMSConnection *connection,
                                                int paramtype,
                                                char *buffer,
                                                size_t buflen,
                                                size_t *paramlenp);
 
SOMAPI_CDECL int SOMStoreGetMailbox (struct SOMMSData *data,
                                     void **prev,
                                     char *buffer,
                                     size_t buflen,
                                     size_t *paramlenp);
 
SOMAPI_CDECL int SOMStoreGetConnection (struct SOMMSData *data,
                                        void **prev,
                                        int *valp);
 
SOMAPI_CDECL int SOMStoreGetMessage (struct SOMMSData *data,
                                     void **prev,
                                     char *buffer,
                                     size_t buflen,
                                     size_t *paramlenp);
 
 
SOMAPI_CDECL int SOMStoreConnectionGetIntParam (struct SOMMSConnection *con,
                                                int paramtype,
                                                int *valp);
 
SOMAPI_CDECL int SOMStoreMailboxGetStrParam (struct SOMMSMailbox *mbx,
                                             int paramtype,
                                             char *buffer,
                                             size_t buflen,
                                             size_t *paramlenp);
 
 
SOMAPI_CDECL int SOMStoreMailboxGetIntParam (struct SOMMSMailbox *mbx,
                                             int paramtype,
                                             int *valp);
 
SOMAPI_CDECL int SOMStoreMessageGetStrParam (struct SOMMSMessage *message,
                                             int paramtype,
                                             char *buffer,
                                             size_t buflen,
                                             size_t *paramlenp);
 
 
SOMAPI_CDECL int SOMStoreMessageGetIntParam (struct SOMMSMessage *message,
                                             int paramtype,
                                             int *valp);
 
 
enum som_storemonitor {
    SOM_STORE_MONITOR_NONE,            
    SOM_STORE_MONITOR_CONNECTIONS,     
    SOM_STORE_MONITOR_MAILBOXES,     
};
 
SOMAPI_CDECL int SOMStoreMonitor (struct SOMSession *session,
                                  enum som_storemonitor type,
                                  void *ophandle,
                                  int async);
 
enum som_storecontrol {
    SOM_STORE_ABORT,            
    SOM_STORE_SHUTDOWN,         
    SOM_STORE_RESTART,          
    SOM_STORE_LOGOUT,           
    SOM_STORE_BLOCK_OPERATION,  
    SOM_STORE_UNBLOCK_OPERATION,
    SOM_STORE_MAXCONNS,         
    SOM_STORE_MAXVOL,           
    SOM_STORE_MAXMSGS,          
    SOM_STORE_REBUILD_MAILBOX_LIST
};
 
 
enum som_managemessage {
    SOM_STORE_MESSAGE_DELETE,
    SOM_STORE_MESSAGE_MOVE,
    SOM_STORE_MESSAGE_SETSTATE
};
 
enum som_managemailbox {
    SOM_STORE_MAILBOX_DELETE,
    SOM_STORE_MAILBOX_BACKUP,
    SOM_STORE_MAILBOX_RESTORE,
    SOM_STORE_MAILBOX_RESTORE_MESSAGE,
    SOM_STORE_MAILBOX_REGISTER_AUTOACTION,
    SOM_STORE_MAILBOX_DEREGISTER_AUTOACTION,
    SOM_STORE_TIDY_MAILBOX,
    SOM_STORE_REBUILD_STATS
};
 
SOMAPI_CDECL int SOMStoreManageMailbox (struct SOMSession *session,
                           enum som_managemailbox op,
                           const char *mbx,
                           const char *qualifier,
                           const char *qual2,
                           const char *qual3,
                           void *ophandle,
                           int async);
 
SOMAPI_CDECL int SOMStoreManageMessage (struct SOMSession *session,
                           enum som_managemessage op,
                           const char *source_mbx,
                           int seqnum,
                           const char *dest_mbx,
                           void *ophandle,
                           int async);
 
SOMAPI_CDECL int SOMStoreForwardMessage (struct SOMSession *session,
                                         const char *source_mbx,
                                         int seqnum,
                                         const char *dest_addresses,
                                         const char *covernote,
                                         void *ophandle,
                                         int async);
 
SOMAPI_CDECL int SOMStoreControl (struct SOMSession *session,
                                  enum som_storecontrol control,
                                  char *qualifier,
                                  void *ophandle,
                                  int async);
 
 
SOMAPI_CDECL int SOMStoreStatus (struct SOMSession *session,
                                 void              *ophandle,
                                 int                async);
 
 
SOMAPI_CDECL int SOMStoreConnectionStatus (struct SOMSession *session,
                                           int connectionid,
                                           void *ophandle,
                                           int async);
 
SOMAPI_CDECL int SOMStoreMailboxStatus (struct SOMSession   *session,
                                        char *mailbox,
                                        void *ophandle,
                                        int async);
 
SOMAPI_CDECL int SOMStoreMessageStatus (struct SOMSession   *session,
                                        char *mailbox,
                                        int seqno,
                                        void *ophandle,
                                        int async);
 
SOMAPI_CDECL int SOMStoreMailboxes (struct SOMSession *session,
                                    void              *ophandle,
                                    int                async);
 
SOMAPI_CDECL int SOMStoreConnections (struct SOMSession *session,
                                      void              *ophandle,
                                      int                async);
 
SOMAPI_CDECL int SOMStoreMessages (struct SOMSession *session,
                      char              *mailbox,
                      void              *ophandle,
                      int               async);
 
/* \} */
 
#endif /* _SOM_STORE_H */