x400_mtapi.h File Reference

X.400 Gateway Interface. More...

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

Go to the source code of this file.

Defines

#define X400mtOpen(p1, p2) X400mtOpenVer(p1, p2, X400_API_VERSN)

Functions

const char * X400mtError (int error)

Return string for error code.

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

Open a session to the MTA.

int X400mtClose (struct X400mtSession *sp)

Close a X400 Session.

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

Set a default integer parameter value in a session.

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

Set a default string parameter value in a session.

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

Creates new message.

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

Returns count of addresses of given type in message object.

int X400mtMsgSend (struct X400mtMessage *mp)

Send message object to MTA.

int X400mtMsgDelete (struct X400mtMessage *mp)

Delete message object.

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

Add string-valued parameter to the message.

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

Add integer-valued parameter to the message.

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

Add an attachment to the message.

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

Add a body part object to a message.

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

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

Add a message body part object to a message.

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

Add new recipient to a message.

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

Add string-valued parameter to the message.

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

Add integer-valued parameter to the message.

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

Wait for messages to be transferred out.

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

Transfer message object out from MTA completely.

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

Get message object for transfer out from MTA.

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

Finish transfer-out of message from MTA, generate DR if required.

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

Return a string-valued parameter from the message object.

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

Return a integer-valued parameter from the message object.

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

Return a integer-valued parameter from the message object.

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

Return a pointer to a body part object.

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

Return a pointer to a body part object.

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

Get recipient object from message.

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

Return a string-valued parameter from the recipient object.

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

Return a integer-valued parameter from the recipient object.

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

Create a new DL Expansion History object from the message object.

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

Create a new DL Expansion History object, and associate it with the existing message.

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

Get a Trace Info object for a message object.

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

Create a new Trace Info object for a message object.

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

Get an Internal Trace Info object for a message object.

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

Create a new Internal Trace Info object for a message object.

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

Create a new Address List Indicator object for a message object.

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

Get a new Address List Indicator object for a message object.

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

Create a new Printable String Syntax object for a message object.

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

Get a new Printable String Syntax object for a message object.

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

Create a new P772 Distribution Field object for a message object.

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

Get a new P772 Distribution Field object for a message object.

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

Create a new P772 Other Recipient object for a message object.

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

Get a new P772 Other Recipient object for a message object.

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

Get the Redirection History object from a message envelope this is represented by 8.3.1.2.1.5 in X.411.

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

Create a new Redirection History object for a message envelope this is represented by 8.3.1.2.1.5 in X.411.

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

Create new Originator and DL expansion history object.

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

Get Originator and DL expansion history object.

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

Open X400 MT session.

Detailed Description

X.400 Gateway Interface.

This is an API for interfacing to an X400 MTA suitable for building gateway functionality. It provides mechanisms for building and examining X.400 message, probes and reports. It also provides mechanisms for transferring such objects into X.400, and transferring out such objects.

Definition in file x400_mtapi.h.

Define Documentation

#define X400mtOpen	(	p1,
		p2		)	X400mtOpenVer(p1, p2, X400_API_VERSN)

Macro calls X400mtOpenVer() with expected version

Examples:: examples/x400_mtrcv.c, examples/x400_mtsend.c, examples/x400_mtsend_rep.c, and examples/x400_mttutorial.c.

Definition at line 951 of file x400_mtapi.h.

Function Documentation

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

Open X400 MT session.

Parameters:

	credentials	[in] Channel and MTA information
	spp	[out] Receives pointer to new session
	version	[in] Version of API client is using

Returns:: Zero on success or non-zero error code

Section Contents

Documentation

Isode X.400 Gateway API

x400_mtapi.h File Reference

Defines

Functions

Detailed Description

Define Documentation

Function Documentation