Summary: Isode provides a number of APIs which allow integrators and product developers to build components that access the Isode Messaging server products or other products supporting the same protocols.
Queue Access Attribute Names

Macros

#define SOM_QATT_SOMVERSION   1
 
#define SOM_QATT_DESCRIPTION   2
 
#define SOM_QATT_CHANNEL_NAME   3
 
#define SOM_QATT_MTA_NAME   4
 
#define SOM_QATT_MSG_ID   5
 
#define SOM_QATT_RECIP_NO   6
 
#define SOM_QATT_OLDEST_MESSAGE   10
 
#define SOM_QATT_NUMBER_MESSAGES   11
 
#define SOM_QATT_VOLUME_MESSAGES   12
 
#define SOM_QATT_NUMBER_REPORTS   13
 
#define SOM_QATT_ACTIVE   14
 
#define SOM_QATT_ENABLED   15
 
#define SOM_QATT_LAST_ATTEMPT   16
 
#define SOM_QATT_DELAYED_UNTIL   17
 
#define SOM_QATT_LAST_SUCCESS   18
 
#define SOM_QATT_INFO   19
 
#define SOM_QATT_ERROR_COUNT   20
 
#define SOM_QATT_INENABLED   21
 
#define SOM_QATT_HOSTNAME   25
 
#define SOM_QATT_VERSION   26
 
#define SOM_QATT_BOOTTIME   30
 
#define SOM_QATT_MESSAGES_IN   31
 
#define SOM_QATT_MESSAGES_OUT   32
 
#define SOM_QATT_ADDRESSES_IN   33
 
#define SOM_QATT_ADDRESSES_OUT   34
 
#define SOM_QATT_OPS_PERSEC   35
 
#define SOM_QATT_RUNNABLE_CHANS   36
 
#define SOM_QATT_MSGIN_PERSEC   37
 
#define SOM_QATT_MSGOUT_PERSEC   38
 
#define SOM_QATT_MAXCHANS   39
 
#define SOM_QATT_CURRCHANS   40
 
#define SOM_QATT_IN_ASSOC   41
 
#define SOM_QATT_OUT_ASSOC   42
 
#define SOM_QATT_TOTAL_IN_ASSOC   43
 
#define SOM_QATT_TOTAL_OUT_ASSOC   44
 
#define SOM_QATT_REPORT_TIME   45
 
#define SOM_QATT_CHANRATE   46
 
#define SOM_QATT_OPRATEMAX   47
 
#define SOM_QATT_OPRATERESERVE   48
 
#define SOM_QATT_DIRNAME   50
 
#define SOM_QATT_STATUS   51
 
#define SOM_QATT_OSTYPE   52
 
#define SOM_QATT_CREATION_TIME   60
 
#define SOM_QATT_FAILED_IN_ASSOC   62
 
#define SOM_QATT_FAILED_OUT_ASSOC   63
 
#define SOM_QATT_FAILED_CONVERT   64
 
#define SOM_QATT_INDEX   65
 
#define SOM_QATT_HIERARCHY   66
 
#define SOM_QATT_LAST_INBOUND_TIME   67
 
#define SOM_QATT_LAST_OUTBOUND_TIME   68
 
#define SOM_QATT_LOOPS_DETECTED   69
 
#define SOM_QATT_OLDEST_MSGID   70
 
#define SOM_QATT_PROTOCOL   71
 
#define SOM_QATT_RECEIVED_VOLUME   72
 
#define SOM_QATT_TRANSMITTED_VOLUME   73
 
#define SOM_QATT_REFUSE_STATUS   74
 
#define SOM_QATT_REFUSE_TEXT   75
 
#define SOM_QATT_REJECTED_ASSOC   76
 
#define SOM_QATT_REJECTED_MSG   77
 
#define SOM_QATT_REJECTED_STATUS   78
 
#define SOM_QATT_REJECTED_TEXT   79
 
#define SOM_QATT_STORED_RECIPIENTS   80
 
#define SOM_QATT_SUCCESSFUL_CONV   81
 
#define SOM_QATT_DIRECTION   100
 
#define SOM_QATT_CHANTYPE   101
 
#define SOM_QATT_MAXPROC   102
 
#define SOM_QATT_NUM_MTAS   103
 
#define SOM_QATT_PROCESSES   104
 
#define SOM_QATT_MINIMISE_PRIORITY   105
 
#define SOM_QATT_MINIMISE_START   106
 
#define SOM_QATT_MINIMISE_STOP   107
 
#define SOM_QATT_MTA_CONNECTING   201
 
#define SOM_QATT_ASSOCIATION   250
 
#define SOM_QATT_APPLINDEX   251
 
#define SOM_QATT_ASSOCTYPE   252
 
#define SOM_QATT_MAXINCONN   253
 
#define SOM_QATT_MAXOUTCONN   254
 
#define SOM_QATT_INMSGID   270
 
#define SOM_QATT_INBOUND_SIZE   271
 
#define SOM_QATT_RECEIVED_BYTES   272
 
#define SOM_QATT_RETRANSMISSIONS   273
 
#define SOM_QATT_START_TIME   274
 
#define SOM_QATT_MAXRECIPNO   300
 
#define SOM_QATT_MPDU_IDENTIFIER   301
 
#define SOM_QATT_ORIGINATOR   302
 
#define SOM_QATT_CONTENT_TYPE   303
 
#define SOM_QATT_EITS   304
 
#define SOM_QATT_PRIORITY   305
 
#define SOM_QATT_SIZE   306
 
#define SOM_QATT_AGE   307
 
#define SOM_QATT_WARNINTERVAL   308
 
#define SOM_QATT_NUMWARNINGS   309
 
#define SOM_QATT_LATEST_DELIVERY   310
 
#define SOM_QATT_DEFERRED_TIME   311
 
#define SOM_QATT_UAID   312
 
#define SOM_QATT_INETID   313
 
#define SOM_QATT_MSGTYPE   314
 
#define SOM_QATT_UNIQUEID   315
 
#define SOM_QATT_SUBTYPE   316
 
#define SOM_QATT_ADDRESS   400
 
#define SOM_QATT_RECIP_CHANNEL_LIST   401
 
#define SOM_QATT_CHANNELS_DONE   402
 
#define SOM_QATT_MSG_STATUS   403
 
#define SOM_QATT_CONTENT_ID   404
 
#define SOM_QATT_GROUP   405
 
#define SOM_QATT_MSG_STATE   406
 
#define SOM_QATT_MSG_STATUS_CODE   407
 
#define SOM_QATT_OUTBOUND_SIZE   408
 
#define SOM_QATT_TRANSMITTED_BYTES   409
 

Detailed Description

Macro Definition Documentation

#define SOM_QATT_SOMVERSION   1

(I) Version of SOM protocol

Definition at line 138 of file queueatt.h.

#define SOM_QATT_DESCRIPTION   2

(S) Description of object

Definition at line 141 of file queueatt.h.

#define SOM_QATT_CHANNEL_NAME   3

(S) Name of associated channel

Definition at line 144 of file queueatt.h.

#define SOM_QATT_MTA_NAME   4

(S) Name of associated MTA

Definition at line 147 of file queueatt.h.

#define SOM_QATT_MSG_ID   5

(S) Queue ID of associated message

Definition at line 150 of file queueatt.h.

#define SOM_QATT_RECIP_NO   6

(I) Internal recipient number; zero means the originator

Definition at line 153 of file queueatt.h.

#define SOM_QATT_OLDEST_MESSAGE   10

(S) Date/Time of oldest message queued on object

Definition at line 156 of file queueatt.h.

#define SOM_QATT_NUMBER_MESSAGES   11

(I) Number of messages queued on object

Definition at line 159 of file queueatt.h.

#define SOM_QATT_VOLUME_MESSAGES   12

(I) Total size of messages queued on object

Definition at line 162 of file queueatt.h.

#define SOM_QATT_NUMBER_REPORTS   13

(I) Number of reports queued on object

Definition at line 165 of file queueatt.h.

#define SOM_QATT_ACTIVE   14

(I) Number of active instances of object (channel); non-zero means active (MTA or message)

Definition at line 168 of file queueatt.h.

#define SOM_QATT_ENABLED   15

(I) True if enabled for outbound

Definition at line 171 of file queueatt.h.

#define SOM_QATT_LAST_ATTEMPT   16

(S) Date/Time of last attempt

Definition at line 174 of file queueatt.h.

#define SOM_QATT_DELAYED_UNTIL   17

(S) Date/Time of delay, if delayed

Definition at line 177 of file queueatt.h.

#define SOM_QATT_LAST_SUCCESS   18

(S) Date/Time of last success

Definition at line 180 of file queueatt.h.

#define SOM_QATT_INFO   19

(S) Information about last error

Definition at line 183 of file queueatt.h.

#define SOM_QATT_ERROR_COUNT   20

(I) Number of errors

Definition at line 186 of file queueatt.h.

#define SOM_QATT_INENABLED   21

(I) True if enabled for inbound

Definition at line 189 of file queueatt.h.

#define SOM_QATT_HOSTNAME   25

(S) Hostname of system

Definition at line 193 of file queueatt.h.

#define SOM_QATT_VERSION   26

(S) Software version information

Definition at line 196 of file queueatt.h.

#define SOM_QATT_BOOTTIME   30

(S) Date/Time at which the Manager started

Definition at line 199 of file queueatt.h.

#define SOM_QATT_MESSAGES_IN   31

(I) Number of messages in

Definition at line 202 of file queueatt.h.

#define SOM_QATT_MESSAGES_OUT   32

(I) Number of messages out

Definition at line 205 of file queueatt.h.

#define SOM_QATT_ADDRESSES_IN   33

(I) Number of addresses in

Definition at line 208 of file queueatt.h.

#define SOM_QATT_ADDRESSES_OUT   34

(I) Number of addresses out

Definition at line 211 of file queueatt.h.

#define SOM_QATT_OPS_PERSEC   35

(I) 100* Operations per second

Definition at line 214 of file queueatt.h.

#define SOM_QATT_RUNNABLE_CHANS   36

(I) 100* Operations per second

Definition at line 217 of file queueatt.h.

#define SOM_QATT_MSGIN_PERSEC   37

(I) 100* Messages in per second

Definition at line 220 of file queueatt.h.

#define SOM_QATT_MSGOUT_PERSEC   38

(I) 100* Messages out per second

Definition at line 223 of file queueatt.h.

#define SOM_QATT_MAXCHANS   39

(I) Maximum number of channels

Definition at line 226 of file queueatt.h.

#define SOM_QATT_CURRCHANS   40

(I) Current number of channels running

Definition at line 229 of file queueatt.h.

#define SOM_QATT_IN_ASSOC   41

(I) Inbound connections to Queue Manager

Definition at line 232 of file queueatt.h.

#define SOM_QATT_OUT_ASSOC   42

(I) Outbound connections from Queue Manager

Definition at line 235 of file queueatt.h.

#define SOM_QATT_TOTAL_IN_ASSOC   43

(I) Total inbound connections to Queue Manager

Definition at line 238 of file queueatt.h.

#define SOM_QATT_TOTAL_OUT_ASSOC   44

(I) Total outbound connections from Queue Manager

Definition at line 241 of file queueatt.h.

#define SOM_QATT_REPORT_TIME   45

(S) Date/Time for statistics

Definition at line 244 of file queueatt.h.

#define SOM_QATT_CHANRATE   46

(I) 100*average channels with messages

Definition at line 247 of file queueatt.h.

#define SOM_QATT_OPRATEMAX   47

(I) Maximum operation rate for queue manager

Definition at line 250 of file queueatt.h.

#define SOM_QATT_OPRATERESERVE   48

(I) Percentage reserve for higher priority messages

Definition at line 253 of file queueatt.h.

#define SOM_QATT_DIRNAME   50

(S) Directory name of Queue Manager

Definition at line 256 of file queueatt.h.

#define SOM_QATT_STATUS   51

(I) Status of queue manager up (1), down (2), halted(3), congested(4), restarting(5), quiescing(6)

Definition at line 259 of file queueatt.h.

#define SOM_QATT_OSTYPE   52

(S) OS type of system - "windows" or "unix"

Definition at line 264 of file queueatt.h.

#define SOM_QATT_CREATION_TIME   60

(S) Date/Time for statistics

Definition at line 269 of file queueatt.h.

#define SOM_QATT_FAILED_IN_ASSOC   62

(I) Failed inbound associations

Definition at line 272 of file queueatt.h.

#define SOM_QATT_FAILED_OUT_ASSOC   63

(I) Failed inbound associations

Definition at line 275 of file queueatt.h.

#define SOM_QATT_FAILED_CONVERT   64

(I) Failed content conversions

Definition at line 278 of file queueatt.h.

#define SOM_QATT_INDEX   65

(I) (SNMP) Index of channel or MTA

Definition at line 281 of file queueatt.h.

#define SOM_QATT_HIERARCHY   66

(I) Index of parent

Definition at line 284 of file queueatt.h.

#define SOM_QATT_LAST_INBOUND_TIME   67

(S) Time of last inbound association

Definition at line 287 of file queueatt.h.

#define SOM_QATT_LAST_OUTBOUND_TIME   68

(S) Time of last outbound association

Definition at line 290 of file queueatt.h.

#define SOM_QATT_LOOPS_DETECTED   69

(I) Looping messages detected

Definition at line 293 of file queueatt.h.

#define SOM_QATT_OLDEST_MSGID   70

(S) Queue ID of oldest message

Definition at line 296 of file queueatt.h.

#define SOM_QATT_PROTOCOL   71

(S) Object identifier for ourbound protocol

Definition at line 299 of file queueatt.h.

#define SOM_QATT_RECEIVED_VOLUME   72

(I) Received volume in Kbytes

Definition at line 302 of file queueatt.h.

#define SOM_QATT_TRANSMITTED_VOLUME   73

(I) Received volume in Kbytes

Definition at line 305 of file queueatt.h.

#define SOM_QATT_REFUSE_STATUS   74

(I) Refusal status code for last association refused by peer

Definition at line 308 of file queueatt.h.

#define SOM_QATT_REFUSE_TEXT   75

(S) Refusal status text for last association refused by peer

Definition at line 311 of file queueatt.h.

#define SOM_QATT_REJECTED_ASSOC   76

(I) Number of associations rejected by this item

Definition at line 314 of file queueatt.h.

#define SOM_QATT_REJECTED_MSG   77

(I) Number of messages rejected by this item

Definition at line 317 of file queueatt.h.

#define SOM_QATT_REJECTED_STATUS   78

(I) Rejection status code for last association rejected by this

Definition at line 320 of file queueatt.h.

#define SOM_QATT_REJECTED_TEXT   79

(S) Rejection status text for last association rejected by this

Definition at line 323 of file queueatt.h.

#define SOM_QATT_STORED_RECIPIENTS   80

(I) Received volume in Kbytes

Definition at line 326 of file queueatt.h.

#define SOM_QATT_SUCCESSFUL_CONV   81

(I) Successfully converted messages

Definition at line 329 of file queueatt.h.

#define SOM_QATT_DIRECTION   100

(I) Numeric indication of channel direction in/out/both/internal

Definition at line 335 of file queueatt.h.

#define SOM_QATT_CHANTYPE   101

(I) Numeric indication of channel type

Definition at line 338 of file queueatt.h.

#define SOM_QATT_MAXPROC   102

(I) Maximum number of processes

Definition at line 341 of file queueatt.h.

#define SOM_QATT_NUM_MTAS   103

(I) Number of MTAs

Definition at line 344 of file queueatt.h.

#define SOM_QATT_PROCESSES   104

(I) Current number of processes

Definition at line 347 of file queueatt.h.

#define SOM_QATT_MINIMISE_PRIORITY   105

(I) Priority for minimisation

Definition at line 350 of file queueatt.h.

#define SOM_QATT_MINIMISE_START   106

(S) Start time for minimisation

Definition at line 353 of file queueatt.h.

#define SOM_QATT_MINIMISE_STOP   107

(S) Stop time for minimisation

Definition at line 356 of file queueatt.h.

#define SOM_QATT_MTA_CONNECTING   201

(I) Non-zero if attempting connection to MTA

Definition at line 361 of file queueatt.h.

#define SOM_QATT_ASSOCIATION   250

(I) Index of the association relative to the MTA

Definition at line 365 of file queueatt.h.

#define SOM_QATT_APPLINDEX   251

(I) Index of the association in the application as a whole

Definition at line 368 of file queueatt.h.

#define SOM_QATT_ASSOCTYPE   252

(I) Type of association

Definition at line 371 of file queueatt.h.

#define SOM_QATT_MAXINCONN   253

(I) Limit on inbound connections

Definition at line 374 of file queueatt.h.

#define SOM_QATT_MAXOUTCONN   254

(I) Limiton outbound connections

Definition at line 377 of file queueatt.h.

#define SOM_QATT_INMSGID   270

(I) Unique ID for inbound message on MTA

Definition at line 382 of file queueatt.h.

#define SOM_QATT_INBOUND_SIZE   271

(I) Number of bytes to be received for message (0 = not known)

Definition at line 385 of file queueatt.h.

#define SOM_QATT_RECEIVED_BYTES   272

(I) Number of bytes received for message

Definition at line 388 of file queueatt.h.

#define SOM_QATT_RETRANSMISSIONS   273

(I) Number of times message transmission repeated

Definition at line 391 of file queueatt.h.

#define SOM_QATT_START_TIME   274

(S) Time at which association/transfer started

Definition at line 394 of file queueatt.h.

#define SOM_QATT_MAXRECIPNO   300

(I) Maximum recipient number associated with this message

Definition at line 400 of file queueatt.h.

#define SOM_QATT_MPDU_IDENTIFIER   301

(S) X.400 MTS Identifier encoded as for MIXER

Definition at line 403 of file queueatt.h.

#define SOM_QATT_ORIGINATOR   302

(S) Originator address in string form; absent for report

Definition at line 406 of file queueatt.h.

#define SOM_QATT_CONTENT_TYPE   303

(S) Content type

Definition at line 409 of file queueatt.h.

#define SOM_QATT_EITS   304

(S) Space separated list of EITs

Definition at line 412 of file queueatt.h.

#define SOM_QATT_PRIORITY   305

(I) Priority

Definition at line 415 of file queueatt.h.

#define SOM_QATT_SIZE   306

(I) Content size in bytes

Definition at line 418 of file queueatt.h.

#define SOM_QATT_AGE   307

(S) When queued to MTA

Definition at line 421 of file queueatt.h.

#define SOM_QATT_WARNINTERVAL   308

(I) Interval between warnings in hours

Definition at line 424 of file queueatt.h.

#define SOM_QATT_NUMWARNINGS   309

(I) Number of warnings sent

Definition at line 427 of file queueatt.h.

#define SOM_QATT_LATEST_DELIVERY   310

(S) When message will be timed out

Definition at line 430 of file queueatt.h.

#define SOM_QATT_DEFERRED_TIME   311

(S) Message deferred time

Definition at line 433 of file queueatt.h.

#define SOM_QATT_UAID   312

(S) UA ID from envelope

Definition at line 436 of file queueatt.h.

#define SOM_QATT_INETID   313

(S) Internet Message-ID

Definition at line 439 of file queueatt.h.

#define SOM_QATT_MSGTYPE   314

(I) Message (0)/Report (1)/Probe (2)

Definition at line 442 of file queueatt.h.

#define SOM_QATT_UNIQUEID   315

(S) Unique ID for message

Definition at line 445 of file queueatt.h.

#define SOM_QATT_SUBTYPE   316

(S) Subtype of message

Definition at line 448 of file queueatt.h.

#define SOM_QATT_ADDRESS   400

(S) Recipient address in string form

Definition at line 453 of file queueatt.h.

#define SOM_QATT_RECIP_CHANNEL_LIST   401

(S) Space separated list of channels

Definition at line 456 of file queueatt.h.

#define SOM_QATT_CHANNELS_DONE   402

(I) Number of channels processed in channel list

Definition at line 459 of file queueatt.h.

#define SOM_QATT_MSG_STATUS   403

(I) Current status of recipient

Definition at line 462 of file queueatt.h.

#define SOM_QATT_CONTENT_ID   404

(S) ID for specific copy of outbound content

Definition at line 465 of file queueatt.h.

#define SOM_QATT_GROUP   405

(S) Current MTA group for recipient

Definition at line 468 of file queueatt.h.

#define SOM_QATT_MSG_STATE   406

(I) Current state of recipient 0 - normal 1 - active 2 - delayed 3 - disabled 4 - held 5 - paused 6 - deferred

Definition at line 471 of file queueatt.h.

#define SOM_QATT_MSG_STATUS_CODE   407

(I) Last extended status code for recipient

Definition at line 482 of file queueatt.h.

#define SOM_QATT_OUTBOUND_SIZE   408

(I) Number of bytes to be transmitted for message (0 = not known)

Definition at line 485 of file queueatt.h.

#define SOM_QATT_TRANSMITTED_BYTES   409

(I) Number of bytes to be transmitted for message (0 = not known)

Definition at line 488 of file queueatt.h.