CMC_message_summary

A CMC_message_summary structure contains a summary of a message. A message summary includes the type of the message, a reference to it for later retrieval, the size of the message, and other information. Message summaries are useful for previewing messages on low-bandwidth networks without actually retrieving the entire message.

Quick Info

Header file:

XCMC.H

typedef struct { 
     CMC_message_reference     *message_reference; 
     CMC_string     message_type; 
     CMC_string     subject; 
     CMC_time      time_sent; 
     CMC_uint32     byte_length; 
     CMC_recipient     *originator; 
     CMC_flags     summary_flags; 
     CMC_extension     *message_summary_extensions; 
} CMC_message_summary;

Members

message_reference

Pointer to the message reference, a CMC_counted_string structure containing the mailbox identifier for a message. The message reference is unique within a mailbox.

message_type

Pointer to a string that identifies the type of the message. See CMC_message for details.

subject

Pointer to a string containing the subject of the message.

time_sent

A CMC_time structure containing the date and time when the client application submits the message to the CMC implementation.

byte_length

The message size, in bytes. The value should include the size of all the associated features of the message such as attachments and envelope and heading fields. A client application can supply an approximate message size, or if the message size is unknown or unavailable, the value CMC_LENGTH_UNKNOWN.

originator

Pointer to a CMC_recipient structure indicating the message sender.

summary_flags

Bitmask of message summary flags. The following flags can be set:

CMC_SUM_LAST_ELEMENT: The last structure in an array of CMC_message_summary structures. The structure with this flag set must be at the end of the array. If this flag is set to zero for any structure, that structure is not the last array element.
CMC_SUM_READ: The message has been read. If this flag is set to zero, the message has not been read.
CMC_SUM_UNSENT: The client application has not sent the message, for example when the message is a draft. If this flag is set to zero, the client application has sent the message.

message_summary_extensions

Pointer to the first structure in an array of CMC_extension structures representing the message-summary data extensions, if any.