Email Client API Overview

This section provides an overview of the functionality and the architecture of the Email Client component.

Purpose

Email Client API allows listing and accessing of mailboxes and email messages. It also provides functionality to create, forward, reply and search for messages.

Architecture

The Email Client API loads the Email Protocol Plug-ins. The plug-in interface defines functions for email operations and for accessing locally stored email data (accounts, folders, messages and message attachments). The plug-in interface is built on top of the Email Framework, which is based on the ECom framework. The Email Framework includes a common message store service which can be used by the plug-ins. The Email Server is a background process handling mailbox-related events.

In the above diagram components shown in blue color are provided by Symbian platform, components shown in grey color are internal, and components in yellow color are thirdy-party applications.

APIs

The key classes are:

MEmailAddress

Interface to define the email address that is used as recipient or sender in MEmailMessage.

MEmailClientApi

Interface for accessing mailboxes, launching email editor, and viewer.

MEmailFetchObserver

Callback interface which is used for fetching content asynchronously.

MEmailFolder

Interface for accessing folder information and included messages.

MEmailMailbox

Interface that provides information on a mailbox, listing folders in the mailbox and obtaining and creating email messages.

MEmailMessage

Interface for email message abstraction.

MEmailSearchObserver

Observer interface for handling email search results.

MMessageIterator

Interface for iterating messages in a folder.

Typical Uses

The following use cases are supported by the Email Client API:
  • list and access mailboxes.

  • create, reply, and forward messages.

  • search messages.

  • launch a specific mailbox in email application.