PMDF Programmer's Reference Manual
Previous Next Contents Index

PMDFsetRecipientType

Specify whether subsequent addresses are To:, Cc:, or Bcc: addresses.

PASCAL

status = PMDF_set_recipient_type

(nq_context, to, cc, bcc, envelope)

argument information
Argument Data type Access Mechanism
nq_context context pointer read/write reference
to boolean read value
cc boolean read value
bcc boolean read value
envelope boolean read value

C

status = PMDFsetRecipientType

(nq_context, to, cc, bcc, envelope)

argument information 


int PMDFsetRecipientType(PMDF_nq **nq_context, 
                         int       to, 
                         int       cc, 
                         int       bcc, 
                         int       envelope)

Arguments

nq_context

A message enqueue context created with PMDFstartMessageEnvelope.

to

If true, then subsequent addresses added with PMDFaddRecipient will be treated as "To:" addresses (and possibly as "Cc:" or "Bcc:" addresses too). If false, then subsequent addresses will not be treated as "To:" addresses.

cc

If true, then subsequent addresses added with PMDFaddRecipient will be treated as "Cc:" addresses (and possibly as "To:" or "Bcc:" addresses too). If false, then subsequent addresses will not be treated as "Cc:" addresses.

bcc

If true, then subsequent addresses added with PMDFaddRecipient will be treated as "Bcc:" addresses (and possibly as "To:" or "Cc:" addresses too). If false, then subsequent addresses will not be treated as "Bcc:" addresses.

envelope

If true, then all subsequent addresses added with PMDFaddRecipient will be added to the message envelope as envelope "To:" addresses. If false, then subsequent addresses will not be added to the message envelope but can be added to the message header lines.

Description

When PMDFstartMessageEnvelope is called, the defaults to = true, cc = false, bcc = false, envelope = true are established. These defaults can then be changed by calls to PMDFsetRecipientType which can be called as often as is necessary while building the message envelope with PMDFaddRecipient calls. Note that any combination of to, cc, or bcc can simultaneously be set true. For instance, if to and cc are set true, then any address added with PMDFaddRecipient will be treated as both a "To:" and "Cc:" address. It will be added only once to the message envelope if envelope is true, but will appear in both the "To:" and "Cc:" message header line. The settings made with PMDFsetRecipientType only affect the specified message enqueue context and can be subsequently altered by subsequent calls to PMDFsetRecipientType.

Return Values

PMDF__OK Normal, successful completion.
PMDF__BADCONTEXT Illegal or corrupt context. Recipient type not changed.

Previous Next Contents Index