Isode API Customer Documentation

include
/*  Copyright (c) 2003-2026, 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_MSAPI_H
#define _X400_MSAPI_H
 
#include "cdecl.h"
#include "x400_api.h"
 
#include <isode/asn1/MTA-types.h>
 
#define X400_DE_SECURITY_ERROR 12
#define X400_DE_DELIVERY_CONTROL_VIOLATED 1
#define X400_DE_UNSUPPORTED_CRITICAL_FUNCTION 13
#define X400_DE_REMOTE_BIND_ERROR 15
/* \} */
 
#define X400_SP_ASSEMBLY_INSTRUCTIONS_CONFLICT_WITH_SECURITY_SERVICES 0
#define X400_SP_AUTHENTICATION_PROBLEM 1
#define X400_SP_AUTHENTICATION_FAILURE_ON_SUBJECT_MESSAGE 2
#define X400_SP_CONFIDENTIALITY_ASSOCIATION_PROBLEM 3
#define X400_SP_DECRYPTION_FAILED 4
#define X400_SP_DECRYPTION_KEY_UNOBTAINABLE 5
#define X400_SP_FAILURE_OF_PROOF_OF_MESSAGE 6
#define X400_SP_FORBIDDEN_USER_SECURITY_LABEL_REGISTER 7
#define X400_SP_INCOMPATIBLE_CHANGE_WITH_ORIGINAL_SECURITY_CONTEXT 8
#define X400_SP_INTEGRITY_FAILURE_ON_SUBJECT_MESSAGE 9
#define X400_SP_INVALID_SECURITY_LABEL 10
#define X400_SP_INVALID_SECURITY_LABEL_UPDATE 11
#define X400_SP_KEY_FAILURE 12
#define X400_SP_MANDATORY_PARAMETER_ABSENCE 13
#define X400_SP_OPERATION_SECURITY_FAILURE 14
#define X400_SP_REDIRECTION_PROHIBITED 15
#define X400_SP_REFUSED_ALTERNATE_RECIPIENT_NAME 16
#define X400_SP_REPUDIATION_FAILURE_OF_MESSAGE 17
#define X400_SP_RESPONDER_CREDENTIALS_CHECKING_PROBLEM 18
#define X400_SP_SECURITY_CONTEXT_FAILURE 19
#define X400_SP_SECURITY_CONTEXT_PROBLEM 20
#define X400_SP_SECURITY_POLICY_VIOLATION 21
#define X400_SP_SECURITY_SERVICES_REFUSAL 22
#define X400_SP_TOKEN_DECRYPTION_FAILED 23
#define X400_SP_TOKEN_ERROR 24
#define X400_SP_UNABLE_TO_AGGREGATE_SECURITY_LABELS 25
#define X400_SP_UNAUTHORISED_DL_NAME 26
#define X400_SP_UNAUTHORISED_ENTRY_CLASS 27
#define X400_SP_UNAUTHORISED_ORIGINALLY_INTENDED_RECIPIENT_NAME 28
#define X400_SP_UNAUTHORISED_ORIGINATOR_NAME 29
#define X400_SP_UNAUTHORISED_RECIPIENT_NAME 30
#define X400_SP_UNAUTHORISED_SECURITY_LABEL_UPDATE 31
#define X400_SP_UNAUTHORISED_USER_NAME 32
#define X400_SP_UNKNOWN_SECURITY_LABEL 33
#define X400_SP_UNSUPPORTED_ALGORITHM_IDENTIFIER 34
#define X400_SP_UNSUPPORTED_SECURITY_POLICY 35
 
/* \} */
 
#define X400_TYPE_MS 0
#define X400_TYPE_MTA_SUBMIT 1
#define X400_TYPE_MTA_BOTH 2
/* \} */
 
#define X400_EVENT_READ 1
#define X400_EVENT_WRITE 2
#define X400_EVENT_ERROR 4
#define X400_EVENT_ALL (X400_EVENT_READ | X400_EVENT_WRITE | X400_EVENT_ERROR)
/* \} */
 
#define MS_ENTRY_CLASS_STORED_MESSAGES 0
#define MS_ENTRY_CLASS_SUBMITTED_MESSAGES 1
/* \} */
 
#define MS_ENTRY_STATUS_ANY -1
#define MS_ENTRY_STATUS_NEW 0
#define MS_ENTRY_STATUS_LISTED 1
#define MS_ENTRY_STATUS_FETCHED 2
#define MS_ENTRY_STATUS_NEW_OR_LISTED 3
#define MS_ENTRY_STATUS_LISTED_OR_FETCHED 4
/* \} */
 
#define MS_BIND_SIMPLE 0
#define MS_BIND_STRONG_P3 1
#define MS_BIND_STRONG_P7 2
/* \} */
 
#ifndef WANT_DEFINES_ONLY
 
X400MS_CDECL const char* X400msError(int error);
 
struct X400msSession;
struct X400msMessage;
struct X400msListResult;
 
typedef void X400msConnEstablishedCb(struct X400msSession* session, int errorcode, int alert);
 
typedef void X400msConnDroppedCb(struct X400msSession* session, int reason_code, char* diagnostic);
 
typedef void X400msMsgSubmittedCb(struct X400msSession* session, struct X400msMessage* message, int errorcode);
 
typedef void X400msMsgFetchedCb(struct X400msSession* session, struct X400msMessage* message, int type, int seqno, int errorcode);
 
typedef void X400msMsgDeletedCb(struct X400msSession* session, int seqno, int errorcode);
 
typedef void X400msMsgWaitingCb(struct X400msSession* session, int num_messages_waiting, int errorcode);
 
typedef void X400msListCb(struct X400msSession* session, struct X400msListResult* lrp, int errorcode);
 
typedef void X400msRegisterCb(struct X400msSession* session, int errorcode);
 
typedef void X400msAlertCb(struct X400msSession* session);
 
typedef int X400msManageCb(struct X400msSession* session, int fd, int event_mask);
X400MS_CDECL int X400msOpenAsync(int type,
                                 const char* oraddr,
                                 const char* dirname,
                                 const char* credentials,
                                 const char* pa,
                                 const char* ret_psw,
                                 X400msConnEstablishedCb* conupcb,
                                 X400msConnDroppedCb* condowncb,
                                 X400msMsgSubmittedCb* msgsubcb,
                                 X400msMsgFetchedCb* msgfetchcb,
                                 X400msMsgDeletedCb* msgdelcb,
                                 X400msMsgWaitingCb* msgwaitcb,
                                 X400msListCb* listcb,
                                 X400msRegisterCb* registercb,
                                 X400msAlertCb* alertcb,
                                 X400msManageCb* managecb,
                                 X400msManageCb* unmanagecb,
                                 struct X400msSession** spp);
 
X400MS_CDECL int X400msOpenAsyncSession(struct X400msSession* sp,
                                        const char* addr,
                                        const char* dn,
                                        const char* credentials,
                                        const char* pa,
                                        const char* ret_psw,
                                        X400msConnEstablishedCb* conupcb,
                                        X400msConnDroppedCb* condowncb,
                                        X400msMsgSubmittedCb* msgsubcb,
                                        X400msMsgFetchedCb* msgfetchcb,
                                        X400msMsgDeletedCb* msgdelcb,
                                        X400msMsgWaitingCb* msgwaitcb,
                                        X400msListCb* listcb,
                                        X400msRegisterCb* registercb,
                                        X400msAlertCb* alertcb,
                                        X400msManageCb* managecb,
                                        X400msManageCb* unmanagecb);
 
X400MS_CDECL struct X400msSession* X400msNewAsyncSession(int type);
 
X400MS_CDECL int X400msGetHandle(struct X400msSession* session);
 
X400MS_CDECL void X400msSetUserPointer(struct X400msSession* session, void* ptr);
 
X400MS_CDECL void* X400msGetUserPointer(struct X400msSession* session);
 
X400MS_CDECL int X400msGetGeneric(struct X400msMessage* mp, struct X400Message** genp);
 
X400MS_CDECL int
X400msOpen(int type, const char* oraddr, const char* dirname, const char* credentials, const char* pa, int* messages, struct X400msSession** spp);
 
X400MS_CDECL int X400msOpenCheck(int type,
                                 const char* oraddr,
                                 const char* dirname,
                                 const char* credentials,
                                 const char* pa,
                                 const char* ret_psw,
                                 int* messages,
                                 struct X400msSession** spp);
 
X400MS_CDECL void X400msSetConfigRequest(int val);
 
X400MS_CDECL void X400msCancelWait(void);
 
X400MS_CDECL void X400msEnableWait(void);
 
X400MS_CDECL void X400msCancelWaitSession(struct X400msSession* sp);
 
X400MS_CDECL void X400msEnableWaitSession(struct X400msSession* sp);
 
X400MS_CDECL int X400msClose(struct X400msSession* sp);
 
X400MS_CDECL int X400msList(struct X400msSession* sp, char* since_time, struct X400msListResult** lrp);
 
X400MS_CDECL int X400msListEx(struct X400msSession* sp, char* since_time, int entryclass, struct X400msListResult** lrp);
 
X400MS_CDECL int X400msListExAux(struct X400msSession* sp, char* since_time, int entryclass, int entrystatus, struct X400msListResult** lrp);
 
X400MS_CDECL int
X400msListExAuxPri(struct X400msSession* sp, char* since_time, int entryclass, int entrystatus, int priority, struct X400msListResult** lrp);
 
X400MS_CDECL int X400msListExAuxPriBefore(struct X400msSession* sp,
                                          char* since_time,
                                          char* before_time,
                                          int entryclass,
                                          int entrystatus,
                                          int priority,
                                          struct X400msListResult** lrp);
 
X400MS_CDECL int X400msListGetIntParam(struct X400msListResult* lr, int paramtype, int number, int* valp);
 
X400MS_CDECL int X400msListGetStrParam(struct X400msListResult* lr, int paramtype, int number, char* buffer, size_t buflen, size_t* paramlenp);
 
X400MS_CDECL void X400msListFree(struct X400msListResult* lr);
 
X400MS_CDECL int X400msMsgNew(struct X400msSession* sp, int type, struct X400msMessage** mpp);
 
X400MS_CDECL int X400msMsgCountRecip(struct X400msMessage* mp, int type, int* cp);
 
X400MS_CDECL int X400msMsgSend(struct X400msMessage* mp);
 
X400MS_CDECL int X400msMsgDelete(struct X400msMessage* mp, int retain);
 
X400MS_CDECL int X400msMsgAddStrParam(struct X400msMessage* mp, int paramtype, const char* value, size_t length);
 
X400MS_CDECL int X400msMsgAddIntParam(struct X400msMessage* mp, int paramtype, int value);
 
X400MS_CDECL int X400msMsgAddAttachment(struct X400msMessage* mp, int type, const char* string, size_t length);
 
X400MS_CDECL int X400msMsgAddBodypart(struct X400msMessage* mp, struct X400Bodypart* bp);
 
X400MS_CDECL int X400msMsgAddMessageBodyWType(struct X400msMessage* mp, struct X400Message* mbp, int type);
 
X400MS_CDECL int X400msMsgAddMessageBodyWType(struct X400msMessage* mp, struct X400Message* mbp, int type);
X400MS_CDECL int X400msMsgAddMessageBody(struct X400msMessage* mp, struct X400Message* mbp);
 
struct X400Recipient;
 
X400MS_CDECL int X400msRecipNew(struct X400msMessage* mp, int type, struct X400Recipient** rpp);
 
X400MS_CDECL int X400msRecipAddStrParam(struct X400Recipient* rp, int paramtype, const char* value, size_t length);
 
X400MS_CDECL int X400msRecipAddIntParam(struct X400Recipient* rp, int paramtype, int value);
 
X400MS_CDECL int X400msWait(struct X400msSession* sp, int seconds, int* count);
 
X400MS_CDECL int X400msWaitNew(struct X400msSession* sp, int seconds, int* count);
 
X400MS_CDECL int X400msMsgGet(struct X400msSession* sp, int number, struct X400msMessage** mpp, int* typep, int* seqp);
 
X400MS_CDECL int X400msMsgGetEx(struct X400msSession* sp, int number, int entryclass, struct X400msMessage** mpp, int* typep, int* seqp);
 
X400MS_CDECL int X400msMsgGetStart(struct X400msSession* sp, int number, struct X400msMessage** mpp, int* typep, int* seqp);
 
X400MS_CDECL int X400msMsgGetStartEx(struct X400msSession* sp, int number, int entryclass, struct X400msMessage** mpp, int* typep, int* seqp);
 
X400MS_CDECL int X400msMsgGetFinish(struct X400msMessage* mp, int errnum, int problem);
 
X400MS_CDECL int X400msMsgGetStrParam(struct X400msMessage* mp, int paramtype, char* buffer, size_t buflen, size_t* paramlenp);
 
X400MS_CDECL int X400msMsgGetIntParam(struct X400msMessage* mp, int paramtype, int* valp);
 
X400MS_CDECL int X400msMsgGetAttachment(struct X400msMessage* mp, int number, int* typep, char* buffer, size_t buflen, size_t* lengthp);
 
X400MS_CDECL int X400msMsgGetBodypart(struct X400msMessage* mp, int number, int* typep, struct X400Bodypart** bpp);
 
X400MS_CDECL int X400msMsgGetMessageBody(struct X400msMessage* mp, int number, struct X400Message** mpp);
 
X400MS_CDECL int X400msMsgGetCert(struct X400msMessage* mp, int certtype, struct X400Certificate** certp);
 
X400MS_CDECL int X400msMakeIPN(struct X400msMessage* mp, int non_receipt_reason, struct X400msMessage** mpp);
 
X400MS_CDECL int X400msRecipGet(struct X400msMessage* mp, int type, int number, struct X400Recipient** rpp);
 
X400MS_CDECL int X400msRecipGetStrParam(struct X400Recipient* rp, int paramtype, char* buffer, size_t buflen, size_t* paramlenp);
 
X400MS_CDECL int X400msRecipGetIntParam(struct X400Recipient* rp, int paramtype, int* valp);
 
X400MS_CDECL int X400msSetIntDefault(struct X400msSession* sp, int paramtype, int value);
 
X400MS_CDECL int X400msSetStrDefault(struct X400msSession* sp, int paramtype, const char* value, size_t length);
 
X400MS_CDECL int X400msTestSecurityEnv(struct X400msSession* sp);
 
struct X400msAutoActionParameter;
 
X400MS_CDECL int X400msRegisterAutoAction(struct X400msSession* sp, int type, int id, struct X400msAutoActionParameter* aa_param);
 
X400MS_CDECL int X400msDeregisterAutoAction(struct X400msSession* sp, int type, int id);
 
X400MS_CDECL struct X400msAutoActionParameter* X400msNewAutoActionParameter(void);
 
X400MS_CDECL void X400msFreeAutoActionParameter(struct X400msAutoActionParameter* aa_param);
 
X400MS_CDECL int X400msAutoActionParameterAddRecip(struct X400msAutoActionParameter* aap, int reciptype, struct X400Recipient* recip);
 
X400MS_CDECL int X400msAutoActionParameterAddIntParam(struct X400msAutoActionParameter* aap, int paramtype, int value);
 
X400MS_CDECL int X400msAutoActionParameterAddStrParam(struct X400msAutoActionParameter* aap, int paramtype, const char* value, size_t length);
X400MS_CDECL int X400msCheckConnection(struct X400msSession* sp);
 
X400MS_CDECL int X400msDLExpHistGet(struct X400msMessage* mp, int entry, struct X400DLExpHist** hist);
 
X400MS_CDECL int X400msDLExpHistNew(struct X400msMessage* mp, struct X400DLExpHist** histp);
 
struct X400DLExpHist;
 
X400MS_CDECL int X400msALINew(struct X400msMessage* mp, struct X400ALI** ali);
 
X400MS_CDECL int X400msALIGet(struct X400msMessage* mp, int entry, struct X400ALI** info);
 
struct X400ALI;
 
X400MS_CDECL int X400msPSSNew(struct X400msMessage* mp, struct X400PSS** pss, int type);
 
X400MS_CDECL int X400msPSSGet(struct X400msMessage* mp, int type, int entry, struct X400PSS** pss);
 
struct X400PSS;
 
X400MS_CDECL int X400msDistFieldNew(struct X400msMessage* mp, struct X400DistField** pss);
 
X400MS_CDECL int X400msDistFieldGet(struct X400msMessage* mp, int entry, struct X400DistField** pss);
 
struct X400DistField;
 
struct X400OtherRecip;
 
X400MS_CDECL int X400msOtherRecipNew(struct X400msMessage* mp, struct X400OtherRecip** otherrecip);
 
X400MS_CDECL int X400msOtherRecipGet(struct X400msMessage* mp, int entry, struct X400OtherRecip** otherrecip);
 
X400MS_CDECL int X400msRediHistGetEnv(struct X400msMessage* msg, int entry, struct X400RediHist** hist);
 
X400MS_CDECL int X400msTraceInfoGet(struct X400msMessage* mp, int entry, struct X400TraceInfo** info, int type);
struct X400TraceInfo;
 
X400MS_CDECL int X400msInternalTraceInfoGet(struct X400msMessage* mp, int entry, struct X400InternalTraceInfo** info);
struct X400InternalTraceInfo;
 
X400MS_CDECL int X400msORandDLGet(struct X400msMessage* msg, int entry, struct X400ORandDL** or_and_dl);
 
struct X400ORandDL;
 
X400MS_CDECL int X400msGetContentOctets(struct X400msMessage* mp, char* buf, size_t buflen, size_t* lenp);
 
X400MS_CDECL int X400msSetContentOctets(struct X400msMessage* mp, char* buf, size_t len);
 
X400MS_CDECL int X400msACP127RespGet(struct X400msMessage* mp, struct X400ACP127Resp** respp);
 
X400MS_CDECL int X400msACP127RespNew(struct X400msMessage* mp, struct X400ACP127Resp** respp);
 
X400MS_CDECL struct X400ACP127Resp* X400msACP127RespDeepCopy(struct X400msMessage* mp, struct X400ACP127Resp* orig);
X400MS_CDECL int X400msMsgGetRaw(struct X400msSession* sp, struct X400msMessage* mp, char* buffer, size_t buflen, size_t* buflenp);
 
X400MS_CDECL int X400msMsgFromRaw(struct X400msSession* sp, char* buffer, size_t buflen, struct X400msMessage** mpp, int* typep);
 
X400MS_CDECL char* X400msBuildCredentials(int auth_type,
                                          const char* pass,
                                          const char* mtaPassword,
                                          const char* filename,
                                          const char* trustedCACertificatesDirectory,
                                          const char* orAddress,
                                          const char* mtaName,
                                          const char* gdi);
 
X400MS_CDECL int X400msTokeniseCredentials(const char* credentials,
                                           int* auth_type,
                                           char** pass,
                                           char** mtaPassword,
                                           char** filename,
                                           char** trustedCACertificatesDirectory,
                                           char** orAddress,
                                           char** mtaName,
                                           char** gdi);
 
X400MS_CDECL int constructStrongP3UA2MTACreds(const char* filename,
                                              const char* passphrase,
                                              const char* orAddress,
                                              const char* mtaName,
                                              const char* gdi,
                                              struct type_MTA_StrongCredentials* strong);
 
X400MS_CDECL int
constructStrongP7UA2MSCreds(const char* filename, const char* passphrase, const char* orAddress, struct type_MTA_StrongCredentials* strong);
 
X400MS_CDECL int verifyStrongP3MTA2UACreds(const char* credentials, struct type_MTA_StrongCredentials* strong);
 
X400MS_CDECL int verifyStrongP7MS2UACreds(const char* credentials, struct type_MTA_StrongCredentials* strong);
 
#endif /* WANT_DEFINES_ONLY */
 
#endif /* _X400_MSAPI_H */