checkaddress.h File Reference

Switch Operation Management Interface: remote address check interface. More...

#include "session.h"

Go to the source code of this file.

Macros

#define SOM_FACILITY_CHECKADDRESS   (16)
 
#define SOM_CKADR_ATT_X400ADDRESS   1
 
#define SOM_CKADR_ATT_RFC822ADDRESS   2
 
#define SOM_CKADR_ATT_DELIVERED_MTA   3
 
#define SOM_CKADR_ATT_DELIVERED_CHANNEL   4
 
#define SOM_CKADR_ATT_DELIVERED_CHANNEL_WEIGHT   5
 
#define SOM_CKADR_ATT_AUTH   6
 
#define SOM_CKADR_ATT_REDIRECTED_ADDRESS   7
 
#define SOM_CKADR_ATT_REDIRECTED_DN   8
 
#define SOM_CKADR_ATT_REDIRECTED_TIME   9
 
#define SOM_CKADR_ATT_REDIRECTED_REASON   10
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_UID   11
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_GID   12
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_USERNAME   13
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_DIRECTORY   14
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_MAILBOX   15
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_SHELL   16
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_HOME   17
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_FORMAT   18
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_RESTRICTED   19
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_MAILFILTER   20
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_SYSMAILFILTER   21
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_PATH   22
 
#define SOM_CKADR_ATT_LOCAL_DELIVERY_OPTIONS   23
 
#define SOM_CKADR_ATT_LOCAL_DOMAIN   24
 
#define SOM_CKADR_ORIGINATOR   (1)
 
#define SOM_CKADR_RFC822   (1<<1)
 
#define SOM_CKADR_X400   (1<<2)
 
#define SOM_CKADR_DN   (1<<3)
 
#define SOM_CKADR_NORMALIZE_ALL   (1<<4)
 
#define SOM_CKADR_NO_RESPONSIBILITY   (1<<5)
 
#define SOM_CKADR_NO_REDIRECTION   (1<<6)
 
#define SOM_CKADR_PARSE_X400   (1<<7)
 
#define SOM_CKADR_PARSE_RFC822   (1<<8)
 
#define SOM_CKADR_PARSE   (1<<9)
 
#define SOM_CKADR_DOMAIN   (1<<10)
 

Typedefs

typedef void SOMCheckAddressCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMCheckResults *data, int status, const char *errstring)
 Prototype for callback for check address completion. More...
 

Functions

int SOMCheckAddressSetCallback (struct SOMSession *session, SOMCheckAddressCallback *callback, SOMCheckAddressCallback **oldvalue)
 Set the Address Check callback function for this session. More...
 
int SOMCheckAddressGetStrParam (struct SOMCheckResults *res, int paramtype, char *buffer, size_t buflen, size_t *paramlenp)
 Return an string-valued parameter from the check results. More...
 
int SOMCheckAddressGetIntParam (struct SOMCheckResults *res, int paramtype, int *valp)
 Return an integer-valued parameter from the check results. More...
 
int SOMCheckAddress (struct SOMSession *session, const char *address, const char *sender_name, const char *inmta_name, const char *inchannel_name, const int flags, void *ophandle, int async)
 Perform an address check. More...
 

Detailed Description

Switch Operation Management Interface: remote address check interface.

This interface allows a remote address and domain routing checks to be performed, by asking a Queue Manager to do the check on your behalf.

Aynchronous operations return results though the single callback function. This is not called for synchronous operations.

Definition in file checkaddress.h.

Macro Definition Documentation

◆ SOM_FACILITY_CHECKADDRESS

#define SOM_FACILITY_CHECKADDRESS   (16)

Mask use to request address check facility

Definition at line 27 of file checkaddress.h.

Function Documentation

◆ SOMCheckAddressSetCallback()

int SOMCheckAddressSetCallback ( struct SOMSession session,
SOMCheckAddressCallback callback,
SOMCheckAddressCallback **  oldvalue 
)

Set the Address Check callback function for this session.

Parameters
session[in] Pointer to address of session object
callback[in] Address of callback function
oldvalue[out] Pointer to location for previous value of callback function
Returns
zero on success; non-zero on error

callback may be NULL to clear the callback function oldvalue may be NULL, in which case the previous value is not returned