Defer a message for later processing.

PASCAL

status = PMDF_defer_message

(dq_context, increment, reason)

C

status = PMDFdeferMessage

(dq_context, increment, reason, reason_len)

int PMDFdeferMessage(PMDF_dq **dq_context, int increment, char *reason, int reason_len)

Arguments

dq_context

A message dequeue context created with PMDFdequeueInitialize.

increment

If true, the message's retry count will be incremented; otherwise, the retry count will be left unchanged.

reason

Optional text string describing why the message is being deferred. The length of this string should not exceed BIGALFA_SIZE bytes.

reason_len

Length in bytes of reason.

Description

NOTE: Although still supported, this routine is now obsolete. Use the PMDFdequeueMessageEnd routine instead. PMDFdeferMessage can be called to defer processing of the currently accessed message. The deferred message will be left in PMDF's message queues for processing by a subsequent processing job. If the message continues to remain in the message queues long enough, it will be returned by PMDF's message return system. See the message return and bouncing discussions in the PMDF System Manager's Guide for further details on this subject. When a message is deferred, no notification messages will be generated despite any prior calls to PMDFrecipientDisposition. This is because deferring a message with PMDFdeferMessage causes all of the message's recipient addresses to be deferred for later reprocessing.

Return Values

PMDF__OK	Normal, successful completion.
PMDF__BADCONTEXT	Illegal or corrupt context. Message not deferred.