Obtain the NOTARY flags for the previously obtained envelope recipient address.

PASCAL

status = PMDF_get_recipient_flags

(dq_context, flags)

C

status = PMDFgetRecipientFlags

(dq_context, notary_flags)

int PMDFgetRecipientFlags(PMDF_dq **dq_context, int *notary_flags)

Arguments

dq_context

A message dequeue context created with PMDFdequeueInitialize.

notary_flags

Longword integer to receive the 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.). When dequeuing a message, every time PMDFgetRecipient is called and returns PMDF__OK, PMDFgetRecipientFlags should immediately be called afterwords. The notary_flags value returned should then be saved and, once the disposition of the associated envelope recipient address is known, PMDFrecipientDisposition called with the recipient address, the value of notary_flags, and the disposition of the address. notary_flags is a bit-encoded value. The interpretation of the individual bits are given in Table 1-6. These flags are based upon RFC 1891; refer to that document for details on their usage.

Table 1-6 Envelope To: Address NOTARY Flags

Symbolic name	Bit	Mask value	Description
PMDF_RECEIPT_HEADER	0	1	Include the message's header in notification messages concerning this envelope "To:" address. RFC 1891 equivalent: RET=HDRS.
PMDF_RECEIPT_NOHEADER	1	2	Do not include the message's header in notification messages concerning this envelope "To:" address. No RFC 1891 equivalent.
PMDF_RECEIPT_FAILURES	2	4	Send a non-delivery notification (NDN) to the envelope "From:" address if the message cannot be delivered to this envelope "To:" address. RFC 1891 equivalent: NOTIFY=FAILURE.
PMDF_RECEIPT_SUCCESSES	3	8	When the message is successfully delivered to this envelope "To:" address, send a delivery status notification (DSN) to the envelope "From:" address indicating successful delivery. RFC 1891 equivalent: NOTIFY=SUCCESS.
PMDF_RECEIPT_DELAYS	4	16	When delivery of the message to this envelope "To:" address is delayed for some period of time, send send a delivery status notification (DSN) to the envelope "From:" address reporting the delay. RFC 1891 equivalent: NOTIFY=DELAY.
PMDF_RECEIPT_NEVER	6	64	Do not send back notification messages of any sort concerning this envelope "To:" address. RFC 1891 equivalent: NOTIFY=NEVER.

When gatewaying mail to another mail system, the NOTARY information should be converted to equivalent requests in the other mail system. If they cannot be, then a disposition of PMDF_DISP_RELAYED_FOREIGN should be set for the gatewayed envelope "To:" address.

Return Values

PMDF__OK	Normal, successful completion.
PMDF__BADCONTEXT	Illegal or corrupt context. No flags retrieved.
PMDF__NO	Information not available.