Sun Java logo     Previous      Contents      Index      Next     

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

Preface

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

Topics covered in this chapter include:

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:

How This Book Is Organized

This manual describes two distinct interfaces. Each interface has an introductory chapter and a reference chapter and corresponding appendixes. The chapters are described in the table below.

Table 1  How This Book Is Organized 

Chapter

Description

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.

Appendix A, "Error Status Codes Summary"

Describes the error status codes returned by the MTA SDK and mtaSend().

Conventions Used in This Book

The tables in this section describe the conventions used in this book.

Typographic Conventions

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

Table 2  Typographic Conventions 

Typeface

Meaning

Examples

AaBbCc123
(Monospace)

Any text that appears on the computer screen or text that you should type. Can be API and language elements, HTML tags, web site URLs, command names, file names, directory path names, onscreen computer output, sample code.

Edit your.login file.

Use ls -a to list all files.

% You have mail.

AaBbCc123
(Monospace bold)

Text that you should type when it appears within a code example or other onscreen computer output.

% su
Password:

AaBbCc123
(Italic)

A placeholder in a command or path name that you should replace with a real name or value (for example, a variable).

Also can be a book title, new term, or word to be emphasized.

The file is located in the msg_svr_base/bin directory.

Read Chapter 6 in the User’s Guide.

These are called class options.

Do not save the file.

Symbols

The following table describes the symbol conventions used in this book.

Table 3  Symbol Conventions 

Symbol

Description

Example

Meaning

[ ]

Contains optional 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.

-

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.

Default Paths and File Names

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

Table 4  Default Paths and File Names

Term

Description

msg_svr_base

Represents the base installation directory for Messaging Server. The default value of the msg_svr_base installation is as follows:

Solaris™ systems: /opt/SUNWmsgsr

Linux systems: /opt/sun/messaging

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 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.

Related Documentation

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

Messaging Server Documents

Use the following URL to see all the Messaging Server documentation:

http://docs.sun.com/coll/MessagingServer_05q1

The Messaging Server product suite contains other products such as Sun Java™ System Console, Directory Server, and Administration Server. Documentation for these and other products can be found at the following URL:

http://docs.sun.com/db/prod/sunone

In addition to the software documentation, see the Messaging Server Software Forum for technical help on specific Messaging Server product questions. The forum can be found at the following URL:

http://swforum.sun.com/jive/forum.jsp?forum=15

Communications Services Documents

Use either one of the following URLs to see the documentation that applies to all Communications Services products:

http://docs.sun.com/coll/MessagingServer_05q1

The following documents are available:

Accessing Sun Resources Online

For product downloads, professional services, patches and support, and additional developer information, go to the following:

Contacting Sun Technical Support

If you have technical questions about this product that are not answered in the product documentation, go to http://www.sun.com/service/contacting.

Related Third-Party Web Site References

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 document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System Messaging Server 2005Q1 MTA Developer’s Reference, and the part number is 819-0107-10.



Previous      Contents      Index      Next     

Part No: 819-0107-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.