PMDF Programmer's Reference Manual
PMDF-PRM-6.0
Previous
| Contents
PMDF_set_recipient_type
Specify whether subsequent addresses are To:, Cc:, or Bcc: addresses.
VMS FORMAT
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 FORMAT
status = PMDFsetRecipientType
(nq_context, to, cc, bcc, envelope)
argument information
int PMDFsetRecipientType (nq_context, to, cc, bcc,
envelope)
PMDF_nq **nq_context;
int to;
int cc;
int bcc;
int envelope;
ARGUMENTS
nq_context
A message enqueue context created with PMDF_start_message_envelope.
to
If true, then subsequent addresses added with PMDF_add_recipient 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 PMDF_add_recipient 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 PMDF_add_recipient 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 PMDF_add_recipient
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 may be added to the message header lines.
DESCRIPTION
When PMDF_start_message_envelope is called, the defaults
to = true, cc = false,
bcc = false, envelope = true are
established. These defaults may then be changed by calls to
PMDF_set_recipient_type which may be called as often as is necessary
while building the message envelope with PMDF_add_recipient calls. Note
that any combination of to, cc, or
bcc may simultaneously be set true. For instance, if
to and cc are set true, then any
address added with PMDF_add_recipient 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 PMDF_set_recipient_type
only affect the specified message enqueue context and may be
subsequently altered by subsequent calls to PMDF_set_recipient_type.
Return Values
| PMDF__OK |
Normal, successful completion. |
| PMDF__BADCONTEXT |
Illegal or corrupt context. Recipient type not changed. |
Previous
| Next
| Contents