Sun Java System Messaging Server 6 2005Q4 MTA Developer's Reference

Preface

This manual describes the Sun Java^TM System Messaging Server 6 2005Q4 Message Transfer Agent (MTA) Software Development Kit (SDK) and Callable Send facility.

Who Should Use This Book

While this document is primarily intended for system programmers writing mail software, system managers wishing to become more familiar with the inner workings of the MTA may also benefit from a casual reading of this manual.

Programmers wishing to write gateways or channels should use the MTA SDK. Programmers writing code merely to send mail will probably find the Callable Send facility sufficient for their needs.

Before You Read This Book

A working knowledge of the following material is essential to programmers writing software that will create electronic mail messages with the MTA SDK:

Sun Java^TM Enterprise System Messaging Server
RFC 2822 - the successor to RFCs 822 and 1123

Understanding this RFC is essential for programmers writing software that creates electronic mail messages with this SDK.
RFCs 2045, 2046, 2047, and 2049

These RFCs are useful for programmers interested in creating MIME compliant messages.

How This Book Is Organized

This manual describes two distinct interfaces. Each interface has an introductory chapter and a reference chapter and corresponding appendixes.

Chapter 1, MTA SDK Concepts and Overview provides an overview and description of general concepts of the MTA SDK.

Chapter 2, MTA SDK Programming Considerations describes procedures and run time instructions.

Chapter 3, Enqueuing Messages describes the process of submitting a message to the MTA for delivery.

Chapter 4, Dequeuing Messages describes the process of dequeing messages.

Chapter 5, Decoding Messages describes the process of decoding messages.

Chapter 6, MTA SDK Reference contains definitions of the MTA SDK routines.

Chapter 7, Using Callable Send mtaSend() describes the MTA Callable Send facility which is used to send mail messages from the local host.

Chapter 8, mtaSend() Routine Specification provides syntax and item codes for the mtaSend() routine.

Chapter 9, Error Status Codes Summary describes the error status codes returned by the MTA SDK and mtaSend().

Messaging Server Documentation Set

The following table summarizes the books included in the Messaging Server core documentation set.

Table P–1 Messaging Server Documentation Set


Document Title	Contents
Chapter 2, Sun Java System Messaging Server 6 2005Q4 Release Notes, in Sun Java System Communications Services 2005Q4 Release Notes	Contains important information available at the time of release of Sun Java System Messaging Server 6 2005Q4.
Sun Java System Messaging Server 6 2005Q4 Administration Guide	Explains how to administer Messaging Serverand its accompanying software components.
Sun Java System Messaging Server 6 2005Q4 Administration Reference	Describes the Messaging Server Message Transfer Agent (MTA) Software Development Kit (SDK) and Callable Send facility.
Sun Java System Messenger Express 6 2005Q4 Customization Guide	Explains how to customize the look and feel of Sun Java^TM System Messenger Express. Although the product architecture permits an almost unlimited customization of the static portion of the pages served by the Messenger Express HTTP daemon, this guide focuses on how to perform the most commonly requested customizations.

Related Books

The http://docs.sun.com^SM web site enables you to access Sun technical documentation online. You can browse the archive or search for a specific book title or subject.

For other server documentation related to deploying Messaging Server, go to the following:

Access Manager documentation: http://docs.sun.com/app/docs/coll/1292.1
Calendar Server documentation: http://docs.sun.com/app/docs/coll/1313.1
Communications Express documentation: http://docs.sun.com/app/docs/coll/1312.1
Directory Server documentation: http://docs.sun.com/app/docs/coll/1316.1
Instant Messaging documentation: http://docs.sun.com/app/docs/coll/1309.1
Messaging Server documentation: http://docs.sun.com/app/docs/coll/1312.1

Default Paths and File Names

The following table describes the default paths and file names that are used in this book.

Table P–2 Default Paths and File Names


Placeholder	Description	Default Value
`msg_svr_base`	Represents the base installation directory for Messaging Server.	Solaris systems: `/opt/SUNWmsgsr` Linux systems: `/opt/sun/messaging`

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–3 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	A placeholder to be replaced with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online)	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file.

Shell Prompts in Command Examples

The following table shows default system prompts and superuser prompts.

Table P–4 Shell Prompts


Shell	Prompt
C shell on UNIX and Linux systems	`machine_name%`
C shell superuser on UNIX and Linux systems	`machine_name#`
Bourne shell and Korn shell on UNIX and Linux systems	`$`
Bourne shell and Korn shell superuser on UNIX and Linux systems	`#`
Microsoft Windows command line	`C:\`

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–5 Symbol Conventions


Symbol	Description	Example	Meaning
`[ ]`	Contains optional arguments and command options.	`ls [-l]`	The `-l` option is not required.
`{ \| }`	Contains a set of choices for a required command option.	`-d {y\|n}`	The `-d` option requires that you use either the `y` argument or the `n` argument.
`${ }`	Indicates a variable reference.	`${com.sun.javaRoot}`	References the value of the `com.sun.javaRoot` variable.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates menu item selection in a graphical user interface.	File -> New -> Templates	From the File menu, choose New. From the New submenu, choose Templates.

Accessing Sun Resources Online

The docs.sun.com^SM web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. Books are available as online files in PDF and HTML formats. Both formats are readable by assistive technologies for users with disabilities.

To access the following Sun resources, go to http://www.sun.com:

Downloads of Sun products
Services and solutions
Support (including patches and updates)
Training
Research
Communities (for example, Sun Developer Network)

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the part number of this book is 819-2652.