x400_api.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.
 *
 */

/* 
 *
 * @VERSION@
 */

#ifndef X400_API_H

#define X400_API_H

#include "cdecl.h"
#include "x400_att.h"

/* generic X400 recipient */
struct X400Recipient;

/* generic X400 message */
struct X400Message;

/* generic X400 Body Part (Attachment) */
struct X400Bodypart;

/* object for Certificate associated with message */
struct X400Certificate;

/* X400 attribute structure */
struct x400_attribute;

/* X400 DL Expansion List History*/
struct X400DLExpHist;

/* X400 Trace Information Object */
struct X400TraceInfo;

/* X400 Internal Trace Information Object */
struct X400InternalTraceInfo;

/* X400 Redirection History Object */
struct X400RediHist;

/* X400 Address List indicator */
struct X400ALI;

/* X400 Printable String Sequence */
struct X400PSS;

/* X400 Distribution Field Object*/
struct X400DistField;

/* X400 Other Recipient Indicator Object */
struct X400OtherRecip;

/* X400 ACP127 Response Notification */
struct X400ACP127Resp;

/* X400 Originator and DL history Object */
struct X400ORandDL;

/* X400 Security Environment */
struct X400SecurityEnv;    

X400COMMON_CDECL int X400Initialize (char *myname);

X400COMMON_CDECL int X400InitializeLogging (const char *myname, const char *xmlfile);

X400COMMON_CDECL int X400MsgNew (int type,
                                 struct X400Message **mpp);

X400COMMON_CDECL int X400MsgCountRecip(struct X400Message *mp,
                                       int recipient_type,
                                       int *number);

X400COMMON_CDECL int X400MsgFree (struct X400Message *mp);

X400COMMON_CDECL int X400MsgAddAttachment (struct X400Message *mp,
                                           int type,
                                           const char *string,
                                           size_t length);


X400COMMON_CDECL int X400MsgAddBodypart (struct X400Message *mp,
                                         struct X400Bodypart *bp);

X400COMMON_CDECL int X400MsgAddMessageBody (struct X400Message *mp,
                                            struct X400Message *mbp);

X400COMMON_CDECL int X400MsgAddMessageBodyWType (struct X400Message *mp,
                                                 struct X400Message *mbp,
                                                 int type);

X400COMMON_CDECL int X400MsgAddIntParam (struct X400Message *mp,
                                      int paramtype,
                                      int value);

X400COMMON_CDECL int X400MsgAddStrParam (struct X400Message *mp,
                                         int paramtype,
                                         const char *value,
                                         size_t length);

X400COMMON_CDECL int X400MsgAddRecip(struct X400Message *mp,
                                     int reciptype,
                                     struct X400Recipient *recip);

X400COMMON_CDECL int X400MsgGetIntParam(struct X400Message *mp,
                                     int paramtype,
                                     int *valuep);

X400COMMON_CDECL int X400MsgGetStrParam(struct X400Message *mp,
                                     int paramtype,
                                     char *buffer,
                                     size_t buflen,
                                     size_t *paramlenp);

X400COMMON_CDECL int X400MsgGetAttachment (struct X400Message *mp,
                                        int number,
                                        int *typep,
                                        char *buffer,
                                        size_t buflen,
                                        size_t *lengthp);

X400COMMON_CDECL int X400MsgGetBodypart (struct X400Message *mp,
                                         int number,
                                         int *typep,
                                         struct X400Bodypart **bpp);

X400COMMON_CDECL int X400MsgGetMessageBody (struct X400Message *mp,
                                            int number,
                                            struct X400Message **mbpp);

X400COMMON_CDECL int X400MsgGetRecip(struct X400Message *mp,
                                  int recip_type,
                                  int number,
                                  struct X400Recipient **rpp);

X400COMMON_CDECL int X400MsgGetCert(struct X400Message *mp,
                                    int certtype,
                                    struct X400Certificate **certp);


X400COMMON_CDECL int X400RecipNew (int type,
                                   struct X400Recipient **rpp);



X400COMMON_CDECL int X400RecipFree (struct X400Recipient *rpp);

X400COMMON_CDECL int X400RecipAddIntParam (struct X400Recipient *rp,
                                        int paramtype,
                                        int value);

X400COMMON_CDECL int X400RecipAddStrParam (struct X400Recipient *rp,
                                        int paramtype,
                                        const char *value,
                                        size_t length);

X400COMMON_CDECL int X400RecipGetStrParam (struct X400Recipient *rp,
                                        int paramtype,
                                        char *buffer,
                                        size_t buflen,
                                        size_t *paramlenp);

X400COMMON_CDECL int X400RecipGetIntParam (struct X400Recipient *rp,
                                        int paramtype,
                                        int *valp);



X400COMMON_CDECL int X400RecipGetCert(struct X400Recipient *rp,
                                      int certtype,
                                      struct X400Certificate **certp);


X400COMMON_CDECL int X400BodypartNew (int type,
                                      struct X400Bodypart **bpp);



X400COMMON_CDECL int X400BodypartFree (struct X400Bodypart *bpp);

X400COMMON_CDECL int X400BodypartAddIntParam (struct X400Bodypart *bp,
                                              int paramtype,
                                              int value);

X400COMMON_CDECL int X400BodypartAddStrParam (struct X400Bodypart *bp,
                                              int paramtype,
                                              const char *value,
                                              size_t length);

X400COMMON_CDECL int X400BodypartGetStrParam (struct X400Bodypart *bp,
                                              int paramtype,
                                              char *buffer,
                                              size_t buflen,
                                              size_t *paramlenp);

X400COMMON_CDECL int X400BodypartGetIntParam (struct X400Bodypart *bp,
                                              int paramtype,
                                              int *valp);



X400COMMON_CDECL int X400DefaultsNew (struct x400_attribute **ap);

X400COMMON_CDECL int X400DefaultsFree (struct x400_attribute *ap);


X400COMMON_CDECL int X400SetStrDefault(struct x400_attribute *ap,
                                    int paramtype,
                                    const char *value,
                                    size_t length);

X400COMMON_CDECL int X400SetIntDefault(struct x400_attribute *ap,
                                    int paramtype,
                                    int value);

X400COMMON_CDECL const char *X400Error(int error);

X400COMMON_CDECL int X400DLExpHistGet (struct X400Message *mp,
                                       int entry,
                                       struct X400DLExpHist **hist);

X400COMMON_CDECL int X400DLExpHistDelete (struct X400DLExpHist *hist);

X400COMMON_CDECL int X400DLExpHistGetStrParam (struct X400DLExpHist *hist,            
                                        int paramtype,
                                        char *buffer,
                                        size_t buflen,
                                        size_t *paramlenp);

/* For backwards compatibility - function had wrong name originally */
#define X400DLGetStrParam X400DLExpHistGetStrParam

X400COMMON_CDECL int X400DLExpHistNew (
    struct X400DLExpHist **histp
);

X400COMMON_CDECL int X400MsgAddDLExpHist(
    struct X400Message *mp,
    struct X400DLExpHist *histp
);


X400COMMON_CDECL int X400DLExpHistAddStrParam (
    struct X400DLExpHist *hist,
    int paramtype,
    const char *value,
    size_t length
);

X400COMMON_CDECL struct X400DLExpHist *X400DLExpHistDeepCopy(struct X400DLExpHist *original);


X400COMMON_CDECL int X400TraceInfoGet(struct X400Message *mp,
                                      int entry,
                                      struct X400TraceInfo **info,
                                      int trace_info_type);

X400COMMON_CDECL int X400TraceInfoGetStrParam (struct X400TraceInfo *info,
                                               int paramtype,
                                               char *buffer,
                                               size_t buflen ,
                                               size_t *paramlenp);
X400COMMON_CDECL int X400TraceInfoGetIntParam (struct X400TraceInfo *info,
                                               int paramtype,
                                               int *valuep);



X400COMMON_CDECL int X400TraceInfoNew(
    struct X400Message    *msg,
    struct X400TraceInfo **info,
    int type
);


X400COMMON_CDECL struct X400TraceInfo *X400TraceInfoDeepCopy(struct X400Message *mp,
                                                             struct X400TraceInfo *original,
                                                             int type);

X400COMMON_CDECL int X400MsgAddTraceInfo(
    struct X400Message *mp,
    struct X400TraceInfo *info,
    int type
);

X400COMMON_CDECL int X400TraceInfoAddStrParam (
    struct X400TraceInfo *info,
    int paramtype,
    const char *value,
    size_t length
);


X400COMMON_CDECL int X400TraceInfoAddIntParam(
    struct X400TraceInfo *info,
    int paramtype,
    int value
);


X400COMMON_CDECL int X400RediHistAddStrParam (
    struct X400RediHist *hist,
    int paramtype,
    const char *value,
    size_t length
);

X400COMMON_CDECL int X400RediHistAddIntParam (
    struct X400RediHist *hist,
    int paramtype,
    int value
);


X400COMMON_CDECL int X400RediHistGetStrParam (
    struct X400RediHist *hist,
    int paramtype,
    char *value,
    size_t length,
    size_t *lengthp
);


X400COMMON_CDECL int X400RediHistGetIntParam (struct X400RediHist *info,
                                              int paramtype,
                                              int *valuep);

X400COMMON_CDECL int X400RediHistGet(struct X400Recipient *recip,
                                     int entry,
                                     struct X400RediHist **hist);

X400COMMON_CDECL int X400RediHistNew(
    struct X400Recipient *recip,
    struct X400RediHist **hist
);

X400COMMON_CDECL int X400RediHistGetEnv(struct X400Message *msg,
                                        int entry,
                                        struct X400RediHist **hist);

X400COMMON_CDECL int X400RediHistNewEnv(
    struct X400Message *msg,
    struct X400RediHist **hist
);


X400COMMON_CDECL struct X400RediHist *X400RediHistDeepCopyEnv(struct X400Message *msg,
                                                              struct X400RediHist *original);


X400COMMON_CDECL struct X400RediHist *X400RediHistDeepCopy(struct X400Recipient *recip,
                                                           struct X400RediHist *original);

X400COMMON_CDECL const char * X400RediReason(
    int redirection_reason
);


X400COMMON_CDECL int X400InternalTraceInfoGet(struct X400Message *mp,
                                              int entry,
                                              struct X400InternalTraceInfo **info);

X400COMMON_CDECL struct X400InternalTraceInfo *X400InternalTraceInfoDeepCopy(
     struct X400Message *mp,
     struct X400InternalTraceInfo *original);

X400COMMON_CDECL int X400InternalTraceInfoNew(
    struct X400Message    *msg,
    struct X400InternalTraceInfo **info
);


X400COMMON_CDECL int X400MsgAddInternalTraceInfo(
    struct X400Message *mp,
    struct X400InternalTraceInfo *info
);

X400COMMON_CDECL int X400InternalTraceInfoGetStrParam (struct X400InternalTraceInfo *info,
                                                       int paramtype,
                                                       char *buffer,
                                                       size_t buflen ,
                                                       size_t *paramlenp);

X400COMMON_CDECL int X400InternalTraceInfoGetIntParam (struct X400InternalTraceInfo *info,
                                                       int paramtype,
                                                       int *valuep);

X400COMMON_CDECL int X400InternalTraceInfoAddStrParam (
    struct X400InternalTraceInfo *info,
    int paramtype,
    const char *value,
    size_t length
);


X400COMMON_CDECL int X400InternalTraceInfoAddIntParam(
    struct X400InternalTraceInfo *info,
    int paramtype,
    int value
);



X400COMMON_CDECL int X400ALIGet(struct X400Message *mp,
                                int entry,
                                struct X400ALI **ali);

X400COMMON_CDECL int X400ALINew(
    struct X400Message    *msg,
    struct X400ALI **ali
);

X400COMMON_CDECL struct X400ALI *X400ALIDeepCopy(struct X400Message *mp,
                                                 struct X400ALI *ali);

X400COMMON_CDECL int X400ALIGetStrParam (struct X400ALI *ALI,
                                         int paramtype,
                                         char *buffer,
                                         size_t buflen ,
                                         size_t *paramlenp);

X400COMMON_CDECL int X400ALIGetIntParam (struct X400ALI *ALI,
                                         int paramtype,
                                         int *valuep);

X400COMMON_CDECL int X400ALIAddStrParam (
    struct X400ALI *info,
    int paramtype,
    const char *value,
    size_t length
);


X400COMMON_CDECL int X400ALIAddIntParam(
    struct X400ALI *info,
    int paramtype,
    int value
);

X400COMMON_CDECL int X400PSSGet(
    struct X400Message *mp,
    int type,
    int entry,
    struct X400PSS **pss
);

X400COMMON_CDECL struct X400PSS *X400PSSDeepCopy(struct X400Message *mp,
                                                 struct X400PSS *pss,
                                                 int type);

X400COMMON_CDECL int X400PSSNew(
    struct X400Message    *msg,
    struct X400PSS **pss,
    int type
);

X400COMMON_CDECL int X400PSSGetStrParam (
    struct X400PSS *pss,
    char *buffer,
    size_t buflen ,
    size_t *paramlenp
);

X400COMMON_CDECL int X400PSSAddStrParam (
    struct X400PSS *pss,
    const char *value,
    size_t length
);
X400COMMON_CDECL int X400DistFieldGet(
    struct X400Message *mp,
    int entry,
    struct X400DistField **distfield
);

X400COMMON_CDECL struct X400DistField *X400DistFieldDeepCopy(struct X400Message *mp,
                                                             struct X400DistField *original);

X400COMMON_CDECL int X400DistFieldNew(
    struct X400Message    *msg,
    struct X400DistField **distfield
);

X400COMMON_CDECL int X400DistFieldGetStrParam (
    struct X400DistField *distfield,
    int type,
    char *buffer,
    size_t buflen ,
    size_t *paramlenp
);

X400COMMON_CDECL int X400DistFieldAddStrParam (
    struct X400DistField *distfield,
    int type,
    const char *value,
    size_t length
);

X400COMMON_CDECL int X400OtherRecipGet (
    struct X400Message *mp,
    int entry,
    struct X400OtherRecip **otherrecip
);

X400COMMON_CDECL struct X400OtherRecip *X400OtherRecipDeepCopy(struct X400Message *mp,
                                                               struct X400OtherRecip *original);

X400COMMON_CDECL int X400OtherRecipNew(
    struct X400Message *mp,
    struct X400OtherRecip **otherrecip
);

X400COMMON_CDECL int X400OtherRecipGetStrParam (
    struct X400OtherRecip *otherrecip,
    char *buffer,
    size_t buflen ,
    size_t *paramlenp
);

X400COMMON_CDECL int X400OtherRecipAddStrParam (
    struct X400OtherRecip *otherrecip,
    const char *value,
    size_t length
);

X400COMMON_CDECL int X400OtherRecipAddIntParam(
    struct X400OtherRecip *otherrecip,
    int value
);


X400COMMON_CDECL int X400OtherRecipGetIntParam(
    struct X400OtherRecip *otherrecip,
    int *value
);




X400COMMON_CDECL int X400ACP127RespGet(
    struct X400Message *mp,
    struct X400ACP127Resp **resp
);

X400COMMON_CDECL struct X400ACP127Resp *X400ACP127RespDeepCopy(struct X400Message *mp,
                                                               struct X400ACP127Resp *original);

X400COMMON_CDECL int X400ACP127RespNew(
    struct X400Message   *mp,
    struct X400ACP127Resp **resp
);

X400COMMON_CDECL int X400ACP127RespGetStrParam (
    struct X400ACP127Resp *resp,
    int type,
    char *buffer,
    size_t buflen ,
    size_t *paramlenp
);


X400COMMON_CDECL int X400ACP127RespAddStrParam (
    struct X400ACP127Resp *resp,
    int type,
    const char *value,
    size_t length
);

X400COMMON_CDECL int X400ACP127RespAddIntParam(
    struct X400ACP127Resp *resp,
    int value
);


X400COMMON_CDECL int X400ACP127RespGetIntParam(
    struct X400ACP127Resp *resp,
    int *value
);


X400COMMON_CDECL int  X400ACP127RespNewALI (
    struct X400ACP127Resp *resp,
    struct X400ALI **ali
);

X400COMMON_CDECL int X400ACP127RespGetALI (
    struct X400ACP127Resp *resp,
    struct X400ALI **ali,
    int entry
);


X400COMMON_CDECL int X400ORandDLAddStrParam (
    struct X400ORandDL *or_and_dl,
    int type,
    const char *value,
    size_t length
);

X400COMMON_CDECL struct X400ORandDL *X400ORandDLDeepCopy(struct X400Message *msg,
                                                         struct X400ORandDL *orig);

X400COMMON_CDECL int X400ORandDLNew(
    struct X400Message *msg,
    struct X400ORandDL **or_and_dl
);

X400COMMON_CDECL int X400MsgORandDLGet(
    struct X400Message  *msg,
    int entry,
    struct X400ORandDL **or_and_dl
);


X400COMMON_CDECL int X400ORandDLGetStrParam (
    struct X400ORandDL *or_and_dl,
    int paramtype,
    char *buffer,
    size_t buflen ,
    size_t *paramlenp
);

X400COMMON_CDECL int X400CertGetStrParam (struct X400Certificate *cp,
                                          int paramtype,
                                          char *buffer,
                                          size_t buflen,
                                          size_t *paramlenp);

X400COMMON_CDECL int X400CertGetIntParam (struct X400Certificate *cp,
                                          int paramtype,
                                          int *valp);


X400COMMON_CDECL int X400GetContentOctets(struct X400Message *mp,
                                          char *buf,
                                          size_t buflen,
                                          size_t *lenp);


X400COMMON_CDECL int X400SetContentOctets(struct X400Message *mp, 
                                          char *buf, size_t len);

X400COMMON_CDECL int X400SetupSecEnv(
    struct X400SecurityEnv     **envp,
    struct x400_attribute       *attrs,
    int                          allow_no_id
);  
    
X400COMMON_CDECL int X400SetupMessageSecEnv(
    struct X400SecurityEnv     **msgenvp,
    struct x400_attribute       *msg_attrs,
    struct x400_attribute       *default_attrs
);
    
X400COMMON_CDECL int X400SetupRecipSecenv (
    struct X400SecurityEnv     **recipenvp,
    struct x400_attribute       *recip_attrs,
    struct x400_attribute       *msg_attrs,
    struct x400_attribute       *default_attrs
);

/* \} */

#endif