About This Guide


This manual provides reference information about the iPlanet Messaging Server 5.1 product. iPlanet Messaging Server 5.1 provides a powerful and flexible cross-platform solution to the email needs of enterprises and messaging hosts of all sizes using open Internet standards.

Use this manual as a companion to the iPlanet Messaging Server 5.1 Administrator's Guide. The administrator's guide describes how to configure, maintain, monitor, and troubleshoot iPlanet Messaging Server 5.1. The reference manual provides information about command-line utilities and configuration files. This information enables you to configure, maintain, monitor, and troubleshoot iPlanet Messaging Server 5.1.

Topics covered in this chapter include:

• Who Should Read This Book

• What You Need to Know

• How This Book is Organized

• Document Conventions

• Where to Find Related Information

• Where to Find This Book Online

Who Should Read This Book

---

This manual is intended for highly or moderately technical network administrators with experience in UNIX or Windows NT. These administrators will be configuring, administering, and maintaining iPlanet Messaging Server 5.1. Architects and developers may also use the iPlanet Messaging Server 5.1 Reference Manual. This manual is not intended for end users.

What You Need to Know

---

This book assumes that you are responsible for configuring, administering, and maintaining the Messaging Server software and that you have a general understanding of the following:

• The Internet and the World Wide Web

• iPlanet Administration Server

• iPlanet Directory Server and LDAP

• Netscape Console

How This Book is Organized

---

This book contains the following chapters:

• About This Guide (this chapter)

• Chapter 1 "Messaging Server Command-line Utilities"

  This chapter describes the core Messaging Server utilities.

• Chapter 2 "Message Transfer Agent Command-line Utilities"

  This chapter describes the MTA utilities.

• Chapter 3 "Delegated Administrator Command-line Utilities"

  This chapter describes the utilities for iPlanet Delegated Administrator for Messaging.

• Chapter 4 "Messaging Server Configuration"

  This chapter lists the configuration parameters for the Messaging Server.

• Chapter 5 "MTA Configuration"

  This chapter describes the MTA configuration files.

• Chapter 6 "Messaging Multiplexor"

  This chapter describes the configuration files and configuration parameters for the Messaging Multiplexor.

Document Conventions

---

Monospaced Font

Monospaced font is used for any text that appears on the computer screen or text that you should type. It is also used for filenames, distinguished names, functions, and examples.

Bold Monospaced Font

Bold monospaced font is used to represent text within a code example that you should type.

Italicized Font

Italicized font is used to represent text that you enter using information that is unique to your messaging server. It is used for server paths and names and account IDs.

For example, throughout this document you will see path references of the form:

server-root/msg-instance/...

In these situations, server-root represents the directory path in which you install the server, and msg-instance represents the server instance (or default host machine name) you use when you install it. For example, if you install your server in the directory /usr/iplanet/server5 and use the server instance tango, the actual path is:

/usr/iplanet/server5/msg-tango/

Italicized font is also used for variables within the synopsis of a command line utility. For example, the synopsis for the imadmin admin remove command is:

imadmin admin remove -D login -l userid -n domain -w password [-d domain] [-h] [-i inputfile] [-p idaport] [-X idahost] [-s] [-v]

In the above example, the italicized words are arguments for their associated option. For example, in the -w password option, you would substitute the Top-Level Administrator's password for password when you enter the imadmin admin remove command.

Square or Straight Brackets

Square (or straight) brackets [] are used to enclose optional parameters. For example, in this manual you will see the usage for the readership command described as follows:

readership [-d days] [-p months]

It is possible to run the readership command by itself as follows to start the Messaging Server installation:

readership

However, the presence of [-d days] and [-p months] indicate that there are additional optional parameters that may be added to the readership command. For example, you could use readership command with the -d option to count the number of people who have read messages in a shared folder within the indicated number of days:

readership -d 10

Command Line Prompts

Command line prompts (for example, % for a C-Shell, or $ for a Korn or Bourne shell) are not displayed in the examples. Depending on which operating system environment you are using, you will see a variety of different command line prompts. However, you should enter the command as it appears in the document unless specifically noted otherwise.

Where to Find Related Information

---

In addition to this guide, iPlanet Messaging Server 5.1 comes with supplementary information for administrators as well as documentation for end users and developers. Use the following URL to see all the Messaging Server documentation:

http://docs.iplanet.com/docs/manuals/messaging.html

Listed below are the additional documents that are available:

• iPlanet Messaging Server Administrator's Guide

• iPlanet Messaging Server Installation Guide

• iPlanet Messaging Server Schema Reference

• iPlanet Messaging Server Provisioning Guide

• iPlanet Messaging ServerMigration Guide

• iPlanet Delegated Administrator for Messaging and Collaboration Installation and Administration Guide

Where to Find This Book Online

---

You can find the iPlanet Messaging Server 5.1 Reference Manual online in PDF and HTML formats. To find this book, use this URL:

http://docs.iplanet.com/docs/manuals/messaging.html