Messaging Server Plug-in Data Structures
[Contents] [Previous] [Next] [Index]

Chapter 4
Messaging Server Plug-in Data Structures


Message
pblock
Recipient

This chapter is a reference to Messaging Server API data structures.

For Messaging Server program definitions, see the plugin.h header file. For a quick reference to the functions in this API, see "Messaging Server Function Summary."

WARNING: The type definitions in this section are for informational purposes only, and do not reproduce the actual definitions of the structures. All types mentioned in this document are opaque, and members of the type defined structures are not exposed in the header files. The only access to the members is through the Messaging Server API. §
[Top]


Message

Represents a message.

Syntax
#include <plugin.h>
struct Message;
Description
This structure stores all attributes that define a single message. This includes all envelope information, such as envelope sender, envelope recipients, sender and per-recipient extensions, and so on, as well as RFC-822 attributes such as pointers to the RFC-822 headers and RFC-822 body.

To set or access these attributes, use the functions associated with the Message type.

For more information, see "Data Structures" and "Message Structure."

See Also
AddRecipient, DupMessage, FreeMessage, GetBodyFile, GetFirstRecipient, GetHeaderFile, GetNextRecipient, RemoveRecipient

[Top]


Recipient

Represents the address of the recipient of a message.

Syntax
#include <plugin.h>
typedef struct Address;
typedef Address Recipient;
Description
The Recipient structure is a type of Address that represents the address of the recipient of a message. An address can be an RFC821-compliant address or a newsgroup name string, for example: 'luke@rebelalliance.com' or 'alt.evil.empire'.

To set or access this structure, use the functions associated with the Message type.

For more information, see "Find a Messaging Server entry."

See Also
AddRecipient, RemoveRecipient

[Top]


pblock

Represents a hash table.

Syntax
#include <plugin.h>
struct pblock;
Description
The parameter block represents a hash table that holds hash table entry structures. It is keyed on the name string, which maps the name strings onto their value character strings. The hash function is subject to change and is therefore not made known to application functions.

To access this structure, use the pblock_findval function.

For more information, see "Parameter Block."

See Also
pblock_findval

[Top]


[Contents] [Previous] [Next] [Index]

Last Updated: 08/21/97 22:09:04


Copyright © 1997 Netscape Communications Corporation