PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Specify the envelope id to associate with this message.

VMS FORMAT

status = PMDF_set_envelope_id

(nq_context, envelope_id)

C FORMAT

status = PMDFsetEnvelopeId

(nq_context, envelope_id, envelope_id_len)

int PMDFsetEnvelopeId (nq_context, envelope_id, 
                       envelope_id_len) 
         PMDF_nq **nq_context; 
         char     *envelope; 
         int       envelope_id_len; 

ARGUMENTS

nq_context

A message enqueue context created with PMDF_start_message_envelope.

envelope_id

Envelope id to use for this message. Length may not exceed ALFA_SIZE bytes.

envelope_id_len

Length in bytes of the envelope id.

DESCRIPTION

Messages queued to PMDF carry with them two identification strings -- "id's" for short. The first is the "message id" as seen in the message's RFC 822 Message-id: header line. This id is the same for all copies of a given message. The second id is the envelope id. Each copy of the message has a distinct envelope id. Normally you will only specify these id's yourself when you are re-enqueuing a message to PMDF. In that case, it is important to preserve the envelope id and message id. If you are enqueuing a new message to PMDF, then you should just leave generation of these id's to PMDF: PMDF will automatically generate both of these id's when they are not supplied. Should you wish to set the message id, then include your own Message-id: header line in the enqueued message's RFC 822 header. If you wish to set the envelope id, then do so with this routine. Note, however, that if PMDF has to make multiple copies of the enqueued message, then it is likely that your specified envelope id will not be used. Your message id, however, will be used since a message id is identical across all copies of the message. When re-enqueuing a dequeued message to PMDF, you can get obtain the envelope id and NOTARY flags of the dequeued message via the PMDF_get_envelope_id and PMDF_get_recipient_flags routines. You would then propogate the id and flags forward by calling PMDF_set_envelope_id once after PMDF_start_message_envelope, and by calling PMDF_set_recipient_flags once for each, and prior to each, PMDF_add_recipient call.