PMDF popstore & MessageStore Manager's Guide
PMDF-POP-6.0

Contents (summary)

• Chapter 1 Overview
• Chapter 2 The PMDF MessageStore
• Chapter 3 Options
• Chapter 4 Web-based Management Interface
• Chapter 5 Web-based User Interface
• Chapter 6 UNIX & NT Command Line Management Utility
• Chapter 7 OpenVMS Command Line Management Utility
• Chapter 8 Migration
• Chapter 9 Report Generation
• Chapter 10 Inbound Message Delivery & Message Bouncer
• Chapter 11 Servers
• Chapter 12 Application Program Interface (API)
• Chapter 13 Logging
• Chapter 14 Miscellaneous Subroutines
• Index
• Figures
• Examples
• Tables

Contents

• ---

  Chapter 1 Overview
  • 1.1 Introduction
  • 1.2 Licensing
  • 1.3 Accounts
    • 1.3.1 Account naming
      • 1.3.1.1 The preferred naming scheme
      • 1.3.1.2 The default naming scheme
      • 1.3.1.3 Another obsolete naming scheme
    • 1.3.2 Account passwords
      • 1.3.2.1 Password location
      • 1.3.2.2 Using the operating system's password database
    • 1.3.3 Account quotas
    • 1.3.4 Management groups
    • 1.3.5 User domains
    • 1.3.6 Account usage flags
    • 1.3.7 Privileged accounts
    • 1.3.8 Bulk loading
    • 1.3.9 Account storage
  • 1.4 Messages
  • 1.5 Forwarding mail

• ---

  Chapter 2 The PMDF MessageStore
  • 2.1 Introduction
  • 2.2 Licensing
  • 2.3 Accounts
    • 2.3.1 Account naming
  • 2.4 Messages
  • 2.5 Management
    • 2.5.1 Web-based management utility
    • 2.5.2 Command line management utility
    • 2.5.3 IMAP-based management utilities
    • 2.5.4 Reconstruct utility
  • 2.6 Application Program Interface (API)

• ---

  Chapter 3 Options
  • 3.1 Location of the option files
  • 3.2 Option file formats
  • 3.3 Options for both the popstore and the MessageStore
  • 3.4 popstore specific options
  • 3.5 MessageStore specific options

• ---

  Chapter 4 Web-based Management Interface
  • 4.1 Using the management interface
    • 4.1.1 Restricting access
    • 4.1.2 Location of the management interface
  • 4.2 The management CGI
    • 4.2.1 Processing HTTP requests
    • 4.2.2 Generating HTTP responses
    • 4.2.3 An example
    • 4.2.4 Management commands
      • 4.2.4.1 add_group command: add a new management group
      • 4.2.4.2 add_user command: add a new user account
      • 4.2.4.3 copy_user command: copy an existing user account
      • 4.2.4.4 delete_group command: delete a management group
      • 4.2.4.5 delete_message command: delete a user's message
      • 4.2.4.6 delete_messages command: delete a user's messages
      • 4.2.4.7 delete_user command: delete a user account
      • 4.2.4.8 forward command: establish a forwarding address
      • 4.2.4.9 list_forward command: list forwarding addresses
      • 4.2.4.10 list_groups command: list management groups
      • 4.2.4.11 list_users command: list user accounts
      • 4.2.4.12 modify_group command: modify a management group definition
      • 4.2.4.13 modify_user command: modify a user account
      • 4.2.4.14 rename_user command: rename a user account
      • 4.2.4.15 show_counters command: show channel counters
      • 4.2.4.16 show_message command: show a user's message
      • 4.2.4.17 show_user command: show a user account
      • 4.2.4.18 unforward command: remove a forwarding address

• ---

  Chapter 5 Web-based User Interface
  • 5.1 Using the user interface
    • 5.1.1 Restricting access
    • 5.1.2 Location of the user interface
  • 5.2 The user CGIs
    • 5.2.1 User interface commands
      • 5.2.1.1 delete command: delete a stored message
      • 5.2.1.2 show command: show a stored message
      • 5.2.1.3 set_pwd command: change the user's password
      • 5.2.1.4 show_user command: show information about the user's account
    • 5.2.2 Header trimming of displayed messages

• ---

  Chapter 6 UNIX & NT Command Line Management Utility
  • 6.1 Basic operation
  • 6.2 Adding new accounts
  • 6.3 Listing accounts
  • 6.4 Modifying accounts
  • 6.5 Removing accounts
  • 6.6 Changing new account defaults
  • 6.7 Bulk loading accounts
  • 6.8 Returning or deleting messages
  • 6.9 Account quotas
  • 6.10 Blocking access, blocking new mail, and locking passwords
  • 6.11 Forwarding mail
  • 6.12 Management groups
  • 6.13 User domains
    • 6.13.1 Enabling user domains
    • 6.13.2 Creating a new user domain
    • 6.13.3 Managing a user domain
    • 6.13.4 Deleting a user domain
  • 6.14 Use of the utility by non-privileged users
  • 6.15 Information display formats
    • 6.15.1 Changing default display formats
    • 6.15.2 Report generation
  • 6.16 Recreating the default account
  • 6.17 Command descriptions
  • Command 1 add
  • Command 2 copy
  • Command 3 delete
  • Command 4 exit
  • Command 5 forward
  • Command 6 group
  • Command 7 login
  • Command 8 logout
  • Command 9 modify
  • Command 10 noforward
  • Command 11 quit
  • Command 12 rename
  • Command 13 run
  • Command 14 set domain
  • Command 15 set storage_units
  • Command 16 set time_units
  • Command 17 show
  • Command 18 test

• ---

  Chapter 7 OpenVMS Command Line Management Utility
  • 7.1 Basic operation
  • 7.2 Adding new accounts
  • 7.3 Listing accounts
  • 7.4 Modifying accounts
  • 7.5 Removing accounts
  • 7.6 Changing new account defaults
  • 7.7 Bulk loading accounts
  • 7.8 Returning or deleting messages
  • 7.9 Account quotas
  • 7.10 Blocking access, blocking new mail, and locking passwords
  • 7.11 Forwarding mail
  • 7.12 Management groups
  • 7.13 User domains
    • 7.13.1 Enabling user domains
    • 7.13.2 Creating a new user domain
    • 7.13.3 Managing a user domain
    • 7.13.4 Deleting a user domain
  • 7.14 Use of the utility by non-privileged users
  • 7.15 Information display formats
    • 7.15.1 Changing default display formats
    • 7.15.2 Report generation
  • 7.16 Recreating the default account
  • 7.17 Command descriptions
  • Command 19 ADD
  • Command 20 COPY
  • Command 21 DELETE
  • Command 22 EXIT
  • Command 23 FORWARD
  • Command 24 GROUP
  • Command 25 LOGIN
  • Command 26 LOGOUT
  • Command 27 MODIFY
  • Command 28 NOFORWARD
  • Command 29 QUIT
  • Command 30 RENAME
  • Command 31 SET DOMAIN
  • Command 32 SET STORAGE_UNITS
  • Command 33 SET TIME_UNITS
  • Command 34 SHOW
  • Command 35 TEST

• ---

  Chapter 8 Migration
  • 8.1 Migrating the popstore to another platform
  • 8.2 Migrating mailboxes
    • 8.2.1 Migrating UNIX and NT mailboxes
  • Command 36 movein
    • 8.2.2 Migrating OpenVMS mailboxes
  • Command 37 MOVEIN

• ---

  Chapter 9 Report Generation
  • 9.1 Writing a formatting file
  • 9.2 Producing a report
  • 9.3 An example

• ---

  Chapter 10 Inbound Message Delivery & Message Bouncer
  • 10.1 The inbound delivery channel
    • 10.1.1 Rewrite rule
    • 10.1.2 Storage quotas
    • 10.1.3 Delivery notifications
  • 10.2 The message bouncer

• ---

  Chapter 11 Servers
  • 11.1 POP3 servers
  • 11.2 IMAP server
  • 11.3 poppassd server
  • 11.4 HTTP server

• ---

  Chapter 12 Application Program Interface (API)
  • 12.1 Fundamentals
  • 12.2 Creating accounts
    • 12.2.1 From scratch
    • 12.2.2 By copying
  • 12.3 Modifying accounts
  • 12.4 Deleting accounts
  • 12.5 Listing accounts
  • 12.6 Billing accounts
  • 12.7 Storing messages
  • 12.8 Accessing messages
  • 12.9 Using the API from multi-threaded programs
  • 12.10 Compiling and linking programs
  • 12.11 Basic constants, types, and data structures
    • 12.11.1 POPSTORE_user_data structure
    • 12.11.2 POPSTORE_message_ref structure
    • 12.11.3 POPSTORE_user_context structure
  • 12.12 Subroutine descriptions
  • Command 38 POPSTORE_command
  • Command 39 POPSTORE_command_d
  • Command 40 POPSTORE_end
  • Command 41 POPSTORE_error_to_text
  • Command 42 POPSTORE_format_counters
  • Command 43 POPSTORE_format_dispose
  • Command 44 POPSTORE_format_forwarding
  • Command 45 POPSTORE_format_forwarding_d
  • Command 46 POPSTORE_format_message
  • Command 47 POPSTORE_format_messages
  • Command 48 POPSTORE_format_profile
  • Command 49 POPSTORE_format_profiles
  • Command 50 POPSTORE_format_profiles_d
  • Command 51 POPSTORE_format_read
  • Command 52 POPSTORE_init
  • Command 53 POPSTORE_manage
  • Command 54 POPSTORE_message_begin
  • Command 55 POPSTORE_message_end
  • Command 56 POPSTORE_message_mark_delete
  • Command 57 POPSTORE_message_mark_nodelete
  • Command 58 POPSTORE_message_mark_noread
  • Command 59 POPSTORE_message_mark_read
  • Command 60 POPSTORE_message_read
  • Command 61 POPSTORE_message_return
  • Command 62 POPSTORE_user_begin
  • Command 63 POPSTORE_user_begin_d
  • Command 64 POPSTORE_user_billing
  • Command 65 POPSTORE_user_billing_d
  • Command 66 POPSTORE_user_copy
  • Command 67 POPSTORE_user_copy_d
  • Command 68 POPSTORE_user_create
  • Command 69 POPSTORE_user_create_dispose
  • Command 70 POPSTORE_user_create_set
  • Command 71 POPSTORE_user_delete
  • Command 72 POPSTORE_user_delete_d
  • Command 73 POPSTORE_user_end
  • Command 74 POPSTORE_user_exists
  • Command 75 POPSTORE_user_exists_d
  • Command 76 POPSTORE_user_list
  • Command 77 POPSTORE_user_list_d
  • Command 78 POPSTORE_user_list_abort
  • Command 79 POPSTORE_user_pw_change
  • Command 80 POPSTORE_user_pw_change_d
  • Command 81 POPSTORE_user_pw_check
  • Command 82 POPSTORE_user_update

• ---

  Chapter 13 Logging
  • 13.1 PMDF-style logging
  • 13.2 The site-supplied logging interface
    • 13.2.1 Linking a shared library
    • 13.2.2 Logging data types
    • 13.2.3 Logging samples
    • 13.2.4 POPSTORE_user_log structure
    • 13.2.5 POPSTORE_message_log structure
    • 13.2.6 POPSTORE_message_store_log structure
    • 13.2.7 POPSTORE_recipient_list structure

• ---

  Chapter 14 Miscellaneous Subroutines
  • 14.1 Computation subroutines
  • 14.2 File locations

• ---

  Index

• ---

  Examples
  • 4-1 list_forwardformatting file
  • 4-2 list_usersformatting file
  • 4-3 show_countersformatting file
  • 4-4 show_messageformatting file
  • 4-5 show_usersaccount formatting file
  • 4-6 show_usersmessage list formatting file
  • 5-1 show_messageformattingfile
  • 5-2 show_useraccount formattingfile
  • 5-3 show_usermessage list formattingfile
  • 9-1 Account listing report
  • 12-1 Creating a new account from scratch
  • 12-2 Creating a new account by copying thedefaultaccount
  • 12-3 Formatting file for account listings
  • 12-4 Generating account listings
  • 12-5 Simple account listing
  • 12-6 Account billing operations
  • 12-7 Message lists
  • 12-8 Displaying new messages
  • 13-1 Logging of a user profile modification
  • 13-2 Logging of a POP3 client downloading and deleting a message
  • 13-3 Logging of the storage of a message
  • 14-1 Defaultcompute_connectsubroutine
  • 14-2 Defaultcompute_block_dayssubroutine
  • 14-3 UNIXmap_profile_filenamesample subroutine
  • 14-4 UNIX/pmdf/table/popstore_profile_pathssample file
  • 14-5 OpenVMSmap_profile_filenamesample subroutine
  • 14-6 OpenVMSPMDF_TABLE:popstore_profile_paths.sample file

• ---

  Figures
  • 1-1 Example management groups

• ---

  Tables
  • 1-1 popstore account fields
  • 2-1 popstore API routines which support the MessageStore
  • 3-1 MessageStore ACL rights
  • 4-1 add_groupcommand parameters
  • 4-2 add_usercommand parameters
  • 4-3 copy_usercommand parameters
  • 4-4 delete_groupcommand parameters
  • 4-5 delete_messagecommand parameters
  • 4-6 delete_messagescommand parameters
  • 4-7 delete_usercommand parameters
  • 4-8 forwardcommand parameters
  • 4-9 list_forwardcommand parameters
  • 4-10 General substitution strings
  • 4-11 list_forwardcommand substitution strings
  • 4-12 list_groupscommand parameters
  • 4-13 list_groupscommand substitution strings
  • 4-14 list_userscommand parameters
  • 4-15 list_userscommand substitution strings
  • 4-16 modify_groupcommand parameters
  • 4-17 modify_usercommand parameters
  • 4-18 rename_usercommand parameters
  • 4-19 show_counterscommand parameters
  • 4-20 show_counterscommand substitution strings
  • 4-21 show_messagecommand parameters
  • 4-22 show_messagecommand substitution strings
  • 4-23 show_usercommand parameters
  • 4-24 show_usermformat command substitution strings
  • 4-25 unforwardcommand parameters
  • 5-1 delete_messagecommandparameters
  • 5-2 showcommand parameters
  • 5-3 set_pwdcommand parameters
  • 5-4 show_usercommand parameters
  • 6-1 Summary of command line management commands (UNIX& NT)
  • 7-1 Summary of command line management commands (OpenVMS)
  • 12-1 Constants
  • 12-2 Basic data types
  • 12-3 Subroutines included in the API
  • 12-4 POPSTORE_user_update operations
  • 13-1 Summary of logging data types
  • 13-2 LOG_ACTIVITY_MASK bit values