x400_mtapi.h

Go to the documentation of this file.

/*  Copyright (c) 2003-2017, 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.
 *
 */

/* 
 *
 * @VERSION@
 */

#ifndef _X400_MTAPI_H
#define _X400_MTAPI_H

#include "cdecl.h"
#include "x400_api.h"



X400MT_CDECL const char *X400mtError (int error);

struct X400mtSession;

X400MT_CDECL int X400mtOpen (const char *credentials,
                             struct X400mtSession **spp);



X400MT_CDECL int X400mtClose (struct X400mtSession *sp);

X400MT_CDECL int X400mtSetIntDefault(struct X400mtSession *sp,
                                     int paramtype,
                                     int value);

X400MT_CDECL int X400mtSetStrDefault(struct X400mtSession *sp,
                                     int paramtype,
                                     const char *value,
                                     size_t length);

struct X400mtMessage;

X400MT_CDECL int X400mtMsgNew (struct X400mtSession *sp,
                               int type,
                               struct X400mtMessage **mpp);

X400MT_CDECL int X400mtMsgCountRecip(struct X400mtMessage *mp, int type, int *cp);

X400MT_CDECL int X400mtMsgSend (struct X400mtMessage *mp);

X400MT_CDECL int X400mtMsgDelete (struct X400mtMessage *mp);

X400MT_CDECL int X400mtMsgAddStrParam (struct X400mtMessage *mp,
                                       int paramtype,
                                       const char *value,
                                       size_t length);

X400MT_CDECL int X400mtMsgAddIntParam (struct X400mtMessage *mp,
                                       int paramtype,
                                       int value);


X400MT_CDECL int X400mtMsgAddAttachment (struct X400mtMessage *mp,
                                         int type,
                                         const char *string,
                                         size_t length);


X400MT_CDECL int X400mtMsgAddBodypart (struct X400mtMessage *mp,
                                       struct X400Bodypart *bp);

X400MT_CDECL int X400mtMsgAddMessageBody (struct X400mtMessage *mp,
                                          struct X400Message *mbp);

X400MT_CDECL int X400mtMsgAddMessageBodyWType (struct X400mtMessage *mp,
                                               struct X400Message *mbp,
                                               int type);

struct X400Recipient;

X400MT_CDECL int X400mtRecipNew (struct X400mtMessage *mp,
                                 int type,
                                 struct X400Recipient **rpp);


X400MT_CDECL int X400mtRecipAddStrParam (struct X400Recipient *rp,
                                         int paramtype,
                                         const char *value,
                                         size_t length);

X400MT_CDECL int X400mtRecipAddIntParam (struct X400Recipient *rp,
                                         int paramtype,
                                         int value);

       
X400MT_CDECL int X400mtWait (struct X400mtSession *sp,
                             int seconds,
                             int *count);

X400MT_CDECL int X400mtMsgGet (struct X400mtSession *sp,
                               struct X400mtMessage **mpp,
                               int *typep);

X400MT_CDECL int X400mtMsgGetStart (struct X400mtSession *sp,
                                    struct X400mtMessage **mpp,
                                    int *typep);

X400MT_CDECL int X400mtMsgGetFinish (struct X400mtMessage *mp,
                                     int status,
                                     int reason,
                                     int diag,
                                     const char *info);

X400MT_CDECL int X400mtMsgGetStrParam (struct X400mtMessage *mp,
                                       int paramtype,
                                       char *buffer,
                                       size_t buflen,
                                       size_t *paramlenp);

X400MT_CDECL int X400mtMsgGetIntParam (struct X400mtMessage *mp,
                                       int paramtype,
                                       int *valp);

X400MT_CDECL int X400mtMsgGetCriticality(struct X400mtMessage *mp,
                                         int attType,
                                         int *critp);


X400MT_CDECL int X400mtMsgGetAttachment (struct X400mtMessage *mp,
                                         int number,
                                         int *typep,
                                         char *buffer,
                                         size_t buflen,
                                         size_t *lengthp);


X400MT_CDECL int X400mtMsgGetBodypart (struct X400mtMessage *mp,
                                       int number,
                                       int *typep,
                                       struct X400Bodypart **bpp);


X400MT_CDECL int X400mtMsgGetMessageBody (struct X400mtMessage *mp,
                                          int number,
                                          struct X400Message **mpp);

X400MT_CDECL int X400mtRecipGet (struct X400mtMessage *mp,
                                 int type,
                                 int number,
                                 struct X400Recipient **rpp);


X400MT_CDECL int X400mtRecipGetStrParam (struct X400Recipient *rp,
                                         int paramtype,
                                         char *buffer,
                                         size_t buflen,
                                         size_t *paramlenp);

X400MT_CDECL int X400mtRecipGetIntParam (struct X400Recipient *rp,
                                         int paramtype,
                                         int *valp);

X400MT_CDECL int X400mtGetRecipCriticality(struct X400Recipient *rp, int attType, int *critp);

X400MT_CDECL int X400mtDLExpHistGet (struct X400mtMessage *mp,
                                     int entry,
                                     struct X400DLExpHist **hist);

    
struct X400DLExpHist;

X400MT_CDECL int X400mtDLExpHistNew (
     struct X400mtMessage       *mp,
     struct X400DLExpHist       **histp
);


X400MT_CDECL struct X400DLExpHist *X400mtDLExpHistDeepCopy (struct X400mtMessage *mp,
                                                            struct X400DLExpHist *orig);

X400MT_CDECL int X400mtTraceInfoGet (
    struct X400mtMessage *mp,
    int entry,
    struct X400TraceInfo **info,
    int type
);
struct X400TraceInfo;


X400MT_CDECL int X400mtTraceInfoNew(
    struct X400mtMessage *mp,
    struct X400TraceInfo **info,
    int type
);

X400MT_CDECL struct X400TraceInfo *X400mtTraceInfoDeepCopy (struct X400mtMessage *mp,
                                                            struct X400TraceInfo *orig,
                                                            int type);

X400MT_CDECL int X400mtInternalTraceInfoGet (
    struct X400mtMessage *mp,
    int entry,
    struct X400InternalTraceInfo **info
);
struct X400InternalTraceInfo;


X400MT_CDECL int X400mtInternalTraceInfoNew(
    struct X400mtMessage *mp,
    struct X400InternalTraceInfo **info
);

X400MT_CDECL struct X400InternalTraceInfo *X400mtInternalTraceInfoDeepCopy (struct X400mtMessage *mp,
                                                            struct X400InternalTraceInfo *orig);

struct X400ALI;


X400MT_CDECL int X400mtALINew(
    struct X400mtMessage *mp,
    struct X400ALI **ali
);

X400MT_CDECL struct X400ALI *X400mtALIDeepCopy (struct X400mtMessage *mp,
                                                struct X400ALI *orig);

X400MT_CDECL int X400mtALIGet (
    struct X400mtMessage *mp,
    int entry,
    struct X400ALI **ali
);


struct X400PSS;


X400MT_CDECL int X400mtPSSNew(
    struct X400mtMessage *mp,
    int type,
    struct X400PSS **pss
);

X400MT_CDECL struct X400PSS *X400mtPSSDeepCopy (struct X400mtMessage *mp,
                                                struct X400PSS *orig,
                                                int type);


X400MT_CDECL int X400mtPSSGet (
    struct X400mtMessage *mp,
    int type,
    int entry,
    struct X400PSS **pss
);

struct X400DistField;


X400MT_CDECL int X400mtDistFieldNew(
    struct X400mtMessage *mp,
    struct X400DistField **distfield
);

X400MT_CDECL struct X400DistField *X400mtDistFieldDeepCopy (struct X400mtMessage *mp,
                                                            struct X400DistField *orig);

X400MT_CDECL int X400mtDistFieldGet (
    struct X400mtMessage *mp,
    int entry,
    struct X400DistField **distfield
);


struct X400OtherRecip;


X400MT_CDECL int X400mtOtherRecipNew(
    struct X400mtMessage *mp,
    struct X400OtherRecip **otherrecip
);

X400MT_CDECL struct X400OtherRecip *X400mtOtherRecipDeepCopy (struct X400mtMessage *mp,
                                                              struct X400OtherRecip *orig);

X400MT_CDECL int X400mtOtherRecipGet (
    struct X400mtMessage *mp,
    int entry,
    struct X400OtherRecip **otherrecip
);



X400MT_CDECL int X400mtRediHistGetEnv(struct X400mtMessage *msg,
                                      int entry,
                                      struct X400RediHist **hist);

X400MT_CDECL int X400mtRediHistNewEnv(
    struct X400mtMessage *msg,
    struct X400RediHist **hist
);

X400MT_CDECL struct X400RediHist *X400mtRediHistDeepCopyEnv(struct X400mtMessage *mp,
                                                            struct X400RediHist *orig);

X400MT_CDECL int X400mtORandDLNew(
    struct X400mtMessage *msg,
    struct X400ORandDL **or_and_dl
);

X400MT_CDECL struct X400ORandDL *X400mtORandDLDeepCopy (struct X400mtMessage *mp,
                                                        struct X400ORandDL *orig);

X400MT_CDECL int X400mtORandDLGet(struct X400mtMessage *msg,
                                  int entry,
                                  struct X400ORandDL **or_and_dl);

struct X400ORandDL;
/* Here we add the API versioning into the API, so that it is hidden
 * from the client
 */
#define X400mtOpen(p1, p2) X400mtOpenVer(p1, p2, X400_API_VERSN)

X400MT_CDECL int X400mtOpenVer (const char *credentials,
                             struct X400mtSession **spp, int version);


X400MT_CDECL int X400mtMarkToFault(struct X400mtSession *sp, int attType, int fault);



X400MT_CDECL int X400mtGetContentOctets(struct X400mtMessage *mp,
                                        char *buf,
                                        size_t buflen,
                                        size_t *lenp);


X400MT_CDECL int X400mtSetContentOctets(struct X400mtMessage *mp, 
                                        char *buf, size_t len);


X400MT_CDECL int X400ReadArchive(char *filepath, struct X400Message **mpp);


X400MT_CDECL int X400mtACP127RespGet (struct X400mtMessage *mp, struct X400ACP127Resp **respp);

X400MT_CDECL int X400mtACP127RespNew(struct X400mtMessage *mp, struct X400ACP127Resp **respp);

X400MT_CDECL struct X400ACP127Resp *X400mtACP127RespDeepCopy(struct X400mtMessage *mp,
                                                             struct X400ACP127Resp *orig);

#endif /* _X400_MTAPI_H */