PMDF Programmer's Reference Manual
PMDF-PRM-6.0
Begin
Contents (summary)
Chapter 1
The PMDF API
Chapter 2
Callable SEND
Appendix A
Error Codes
Glossary
Index
Figures
Examples
Tables
Contents
Chapter 1
The PMDF API
1.1
Introduction to the API routines
1.2
Enqueuing messages
1.3
Dequeuing messages
1.4
Multiple message enqueue and dequeue contexts
1.5
Usage from multi-threaded processes
1.6
Message header structures
1.7
Programs which run indefinitely
1.7.1
OpenVMS considerations
1.7.2
UNIX & NT considerations
1.8
Writing output from a channel program
1.9
Debugging programs and logging messaging activity
1.10
Required privileges
1.10.1
OpenVMS systems
1.10.2
UNIX systems
1.10.3
NT systems
1.11
Compiling and linking programs
1.12
Examples of using the API routines
1.12.1
Enqueuing a simple message
1.12.2
Dequeuing messages
1.12.3
Dequeuing & re-enqueuing messages
1.12.4
Dequeuing & returning messages
1.13
API routine descriptions
1.13.1
Summary of routines
1.13.2
Order dependencies
1.13.3
Strings passed to and from the API
1.13.4
Routine descriptions
Command 1
PMDF_abort_message
Command 2
PMDF_abort_program
Command 3
PMDF_add_header_line
Command 4
PMDF_add_recipient
Command 5
PMDF_address_dispose
Command 6
PMDF_address_get
Command 7
PMDF_address_get_property
Command 8
PMDF_address_parse_list
Command 9
PMDF_alias_no_expansion
Command 10
PMDF_cancel_call_back
Command 11
PMDF_close_log_file
Command 12
PMDF_close_queue_cache
Command 13
PMDF_copy_message
Command 14
PMDF_database_add_entry
Command 15
PMDF_database_close
Command 16
PMDF_database_delete_entry
Command 17
PMDF_database_get_entry
Command 18
PMDF_debug
Command 19
PMDF_decode_message
Command 20
PMDF_defer_message
Command 21
PMDF_delete_header_line
Command 22
PMDF_dequeue_end
Command 23
PMDF_dequeue_initialize
Command 24
PMDF_dequeue_message
Command 25
PMDF_dequeue_message_end
Command 26
PMDF_dispose_channel_counters
Command 27
PMDF_dispose_header
Command 28
PMDF_done
Command 29
PMDF_enqueue_initialize
Command 30
PMDF_enqueue_message
Command 31
PMDF_get_address_property
Command 32
PMDF_get_block_size
Command 33
PMDF_get_channel_counters
Command 34
PMDF_get_channel_name
Command 35
PMDF_get_date_time
Command 36
PMDF_get_envelope_id
Command 37
PMDF_get_error_text
Command 38
PMDF_get_host_name
Command 39
PMDF_get_message
Command 40
PMDF_get_message_id
Command 41
PMDF_get_postmaster_address
Command 42
PMDF_get_recipient
Command 43
PMDF_get_recipient_flags
Command 44
PMDF_get_unique_string
Command 45
PMDF_get_user_name
Command 46
PMDF_initialize
Command 47
PMDF_log
Command 48
PMDF_mapping_apply
Command 49
PMDF_mapping_load
Command 50
PMDF_option_dispose
Command 51
PMDF_option_get_integer
Command 52
PMDF_option_get_real
Command 53
PMDF_option_get_string
Command 54
PMDF_option_read
Command 55
PMDF_queue_cache_end
Command 56
PMDF_queue_cache_get_entry
Command 57
PMDF_read_failure_log
Command 58
PMDF_read_header
Command 59
PMDF_read_line
Command 60
PMDF_read_text
Command 61
PMDF_receipt_control
Command 62
PMDF_recipient_disposition
Command 63
PMDF_return_message
Command 64
PMDF_rewind_message
Command 65
PMDF_set_call_back
Command 66
PMDF_set_envelope_id
Command 67
PMDF_set_limits
Command 68
PMDF_set_mutex
Command 69
PMDF_set_recipient_flags
Command 70
PMDF_set_recipient_type
Command 71
PMDF_set_receipt_addresses
Command 72
PMDF_start_message_body
Command 73
PMDF_start_message_envelope
Command 74
PMDF_start_message_header
Command 75
PMDF_write_date
Command 76
PMDF_write_from
Command 77
PMDF_write_header
Command 78
PMDF_write_line
Command 79
PMDF_write_subject
Command 80
PMDF_write_text
Chapter 2
Callable SEND
2.1
Sending a message
2.1.1
Envelope & header From: address
2.1.2
To:, Cc:, and Bcc: addresses
2.1.3
Message headers & content
2.2
Writing output from a channel program
2.3
Required privileges
2.4
Compiling and linking programs
2.5
Examples of using callable SEND
2.5.1
Sending a simple message
2.5.2
Specifying an initial message header
2.5.3
Multiple recipients, FAX addresses, and per address status messages
2.5.4
Using an input procedure
2.6
Summary of PMDF_send item codes
2.7
PMDF_send routine description
Command 81
PMDF_send
Appendix A
Error Codes
Glossary
Index
Examples
1-1
Sample mail message file
1-2
Enqueuing a message (Pascal)
1-3
Enqueuing a message (C)
1-4
Output of Examples|hotspot#39|and|hotspot#40|
1-5
Message dequeuing (Pascal)
1-6
Message dequeuing (C)
1-7
Output of Examples|hotspot#46|and|hotspot#47|
1-8
Message dequeuing& re-enqueuing (Pascal)
1-9
Message dequeuing& re-enqueuing (C)
1-10
Dequeuing& returning messages (Pascal)
1-11
Dequeuing& returning messages (C)
1-12
Output of Examples|hotspot#56|and|hotspot#57|
2-1
Sending a simple message (Pascal)
2-2
Sending a simple message (C)
2-3
Output of Examples|hotspot#104|and|hotspot#105|
2-4
Specifying an initial message header (Pascal)
2-5
Specifying an initial message header (C)
2-6
Input file used in Examples|hotspot#112|and|hotspot#113|
2-7
Output of Examples|hotspot#116|and|hotspot#117|
2-8
Multiple addresses (Pascal)
2-9
Multiple addresses (C)
2-10
Address status messages produced by Examples|hotspot#124|and|hotspot#125|
2-11
Using an input procedure (Pascal)
2-12
Using an input procedure (C)
Figures
1-1
Sample header structure
1-2
Calling precedence for the API message enqueue routines
1-3
Calling precedence for the API message dequeue routines
Tables
1-1
Routines included in the PMDF API
1-2
String size constants used by the API
1-3
Properties of the address
phrase
<@
otherhost
:
user
@
host
>
1-4
Database symbolic names and values
1-5
Channel counters list entry
1-6
Envelope To: address NOTARY flags
1-7
PMDF_queue_cache_get_entry item codes
1-8
Disposition values for use with PMDF_recipient_disposition
2-1
PMDF_send item code summary
Next