PMDF Programmer's Reference Manual


Previous Contents Index


PMDFsetRecipientFlags

Set the NOTARY flags for the next envelope recipient address.

PASCAL

status = PMDF_set_recipient_flags

(nq_context, notary_flags)

argument information

Argument Data type Access Mechanism
nq_context context pointer read/write reference
notary_flags integer read value

C

status = PMDFsetRecipientFlags

(nq_context, notary_flags)

argument information


int PMDFsetRecipientFlags(PMDF_nq **dq_context, 
int notary_flags) 


Arguments

nq_context

A message enqueue context created with PMDFstartMessageEnvelope .

notary_flags

Longword integer containing NOTARY flag bits.

Description

PMDF mail messages carry per recipient NOTARY information in their envelope. This information is aligned with the NOTARY SMTP extension as described in RFC 1891 and describes failure and success handling requested by the sender (e.g., send a delivery receipt, send failure notifications but do not include return of content, never send any form of notifications, etc.). By default, when an envelope recipient address is enqueued, PMDF assigns it the NOTARY handling PMDF_RECEIPT_FAILURES + PMDF_RECEIPT_DELAYS which indicates that non-delivery notifications (NDNs) should be generated for delivery failures and delays. To select, for a given envelope recipient address, different handling characteristics or to propogate NOTARY flags from a previous dequeue operation, call PMDFsetRecipientFlags prior to calling PMDFaddRecipient . The notary_flags argument is a bit mask whose bits are given in Table 1-6. Note that PMDF_RECEIPT_NEVER and PMDF_RECEIPT_FAILURES can not both be set. If both are set, then PMDF_RECEIPT_NEVER will be ignored. Similarly, if both PMDF_RECEIPT_HEADER and PMDF_RECEIPT_NOHEADER are set, then PMDF_RECEIPT_NOHEADER is ignored. When neither are set, then notifications will include full return of content (RET=FULL).

Return Values

PMDF__OK Normal, successful completion.
PMDF__BADCONTEXT Illegal or corrupt context. No flags set.


Previous Next Contents Index