|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The Qt Extended Messaging library provides a set of APIs for accessing Qt Extended messaging data. Interfaces are provided to create, modify, store, retrieve and display messages. The library does not directly support sending or retrieving messages; these actions are currently supported via the QtopiaServiceRequest mechanism. For detailed class information refer to: Messaging Classes.
The Qt Extended Messaging library provides unified access to the messaging data on a Qt Extended device including concurrent access to messaging data by multiple applications, and independence from the mechanism used to store the messaging data on the device.
The Qt Extended Messaging library provides a number of classes to assist with the composition and manipulation of message data. Messages of all supported types are represented uniformly, although not all transport mechanisms are able to deliver more complex message formulations. Messages can be composed of multiple parts and constructed hierarchically. The Qt Extended Messaging Library supports composition of multipart messages from individual part objects.
Classes to assist with composition and manipulation of messages:
| Class | Description |
|---|---|
| QMailMessageId | Represents the mail store identifiers for message records. |
| QMailMessageMetaData | Represents a message stored by the Qt Extended Messaging library. |
| QMailMessage | Convenient interface for working with messages. |
| QMailMessagePart | Convenient interface for working with message attachments. |
| QMailMessagePartContainer | Access to a collection of message parts. |
| QMailMessageBody | The body element of a message or message part. |
| QMailMessageHeaderField | Encapsulates the parsing of message header fields. |
| QMailMessageContentDisposition | Encapsulates the parsing of the RFC 2822 'Content-Disposition' header field. |
| QMailMessageContentType | Encapsulates the parsing of the RFC 2822 'Content-Type' header field. |
| QMailAddress | Interface for manipulating message address strings. |
| QMailTimeStamp | Manages message time stamps. |
| QMailCodec | Base class for classes implementing codecs used in message composition. |
The Qt Extended Messaging Library provides classes for storing information about messaging accounts both outgoing and incoming.
Classes relating to messaging accounts:
| Class | Description |
|---|---|
| QMailAccountId | Represents the mail store identifiers for account records. |
| QMailAccount | Stores attributes for a messaging account. |
| QMailFolderId | Represents the mail store identifiers for folder records. |
| QMailFolder | Represents a folder for messages on the mail store. |
| QMailMessageRemovalRecord | Represents a message deleted from the local mail store. |
| AccountConfiguration | Contains the configuration details for an account. |
The Qt Extended Messaging library provides classes to assist with displaying lists of message data. These classes allow clients to display lists of messages and accounts with minimal effort, and with minimal resource consumption.
Classes to assist with listing messages:
| Class | Description |
|---|---|
| QMailAccountListModel | Provides a model representing the accounts stored by the Qt Extended Messaging library. |
| QMailMessageListModel | Provides a model representing the messages stored by the Qt Extended Messaging library. |
| QMailMessageDelegate | Provides a standard visual representation of a message in a list view. |
The Qt Extended Messaging library provides classes to assist with partitioning and navigating message data according to the intrinsic message properties. The classes allow clients to display a hierarchical taxonomy of message data, using standard or arbitrary categorization criteria.
Classes to assist with navigating messages:
| Class | Description |
|---|---|
| QMailMessageSet | Provides a representation for a subset of the store's messages, suitable for display in a tree view. |
| QMailAccountMessageSet | Provides a message set implementation grouping messages by their parent account ID. |
| QMailFolderMessageSet | Provides a message set implementation grouping messages by their parent folder ID. |
| QMailFilterMessageSet | Provides a message set implementation grouping messages by arbitrary criteria. |
| QMailMessageSetModel | Provides a model representing arbitrary message sets in a tree arrangement. |
The Qt Extended Messaging library provides a number of sort and search functions to aid in selecting data most useful to the view requested. This reduces the burden on the application for managing the messaging data, as well as allowing better use of the underlying storage mechanism.
Sorting is accomplished by providing a sorting key, specifying the sort order, and the message property upon which to sort.
Searching is accomplished by providing a search condition, specifying a value, the message property to match, and the desired relation between the value and the message property. Search conditions can be combined to produce searches of arbitrary complexity.
Classes to assist with sorting and searching messages:
| Class | Description |
|---|---|
| QMailStore | Represents the main interface for storage and retrieval of messages and folders on the mail store. |
| QMailAccountKey | Defines the parameters used for querying a subset of all available accounts from the mail store. |
| QMailAccountSortKey | Defines the parameters used for sorting accounts queried from the mail store. |
| QMailFolderKey | Defines the parameters used for querying a subset of all available mail folders from the mail store. |
| QMailFolderSortKey | Defines the parameters used for sorting mail folders queried from the mail store. |
| QMailMessageKey | Defines the parameters used for querying a subset of all available mail messages from the mail store. |
| QMailMessageSortKey | Defines the parameters used for sorting messages queried from the mail store. |
The Qt Extended Messaging Library uses a plugin system to register components that can compose and view messages. Although this mechanism can be accessed by applications, it is currently recommended that Services should be used to support message composing and viewing requirements.
Classes supporting the use of plugins for message composition and viewing:
| Class | Description |
|---|---|
| QMailComposerFactory | Creates objects implementing the QMailComposerInterface interface |
| QMailViewerFactory | Creates objects implementing the QMailViewerInterface interface |
| QMailComposerInterface | Defines the interface to objects that can compose a mail message |
| QMailViewerInterface | Defines the interface to objects that can display a mail message |
| QMailComposerPlugin | Defines a base class for implementing mail message composer plug-ins |
| QMailViewerPlugin | Defines a base class for implementing mail message viewer plug-ins |
| QMailComposerPluginInterface | Defines the interface to plug-ins that provide mail message composers |
| QMailViewerPluginInterface | Defines the interface to plug-ins that provide mail message viewers |
The Qt Extended Messaging library provides the QMailMessageServer class, which provides an interface for a messaging client application to communicate with the system's messaging server. The messaging server provides services relating to the transmission and retrieval of messages from various sources defined by QMailAccount objects. Using QMailMessageServer, clients can communicate with the messaging server via local-process signals and slots, without having any direct contact with the server process.
The QMailServiceAction class provides a convenient abstraction above the QMailMessageServer interface, allowing clients to handle only events relating to a specific action requested from the messaging server. QMailRetrievalAction, QMailTransmitAction and QMailSearchAction specialize QMailServiceAction to implement specific exchanges between a client application and the messaging server.
The Qt Extended Messaging library provides services permitting client applications to handle the event of new message arrival.
Each of QMailNewSmsHandler, QMailNewMmsHandler, QMailNewEmailHandler, QMailNewInstantMessageHandler and QMailNewSystemMessageHandler can be instantiated to permit a client application to respond to the arrival of new messages of the relevant type.
The Qt Extended Messaging library provides a level of concurrent access to messaging data by multiple applications. The concurrent access does guarantee that data won't be corrupted by concurrent access, however does not give any guarantees as to performance of messaging data access if accessed concurrently by multiple applications.
The Qt Extended Messaging library abstracts the storage method used to store messaging data. On a device the Qt Extended Messaging library will only read and write the primary storage mechanism and synchronizing mechanism.
The Qt Extended Messaging library requires SQL support either through the included SQLite or through some other SQL engine.
| Name | Description |
|---|---|
| MessageViewer | Demonstrates the use of QMailMessageMetaData and QMailMessageKey in finding and viewing messages. |
| MessageNavigator | Demonstrates the use of QMailMessageSetModel and QMailMessageListModel in presenting account, folder and message listings. |
| Copyright © 2009 Trolltech | Trademarks | Qt Extended 4.4.3 |