C++ default constructor.

destructor

Adds a new event observer. There can be several observers active at the same time. Caller MUST call RemoveObserver before destroying given observer object.

Plugins is asked to immediaty execute all authentications that are mandatory to get services from the plugin. This means e.g. store authentication.

cancels pending request

Cancels current search. Does nothing if there is not any search. The search client will not be called back after this function is called.

cancels all ongoing synchronizations in given mailbox regardless if initiated by email framework or plugin itself

Returns child part objects for given email part. Ownership of objects is transferred to user.

Inform the store to clean up its cache for search results.

This method cancels the the ongoing search (if exists), and then clean ups store's cache.

This function should be called when search results are no longer in display.

aMailBoxId id of the mailbox where the search cache should be cleared

close ecom session

Two-phased constructor

Copies given email as new child part to given email part.

return new child part object, ownership is transferred to user

copies contents of this message part to given file

Copies a messages from folder to another. This function copies a messages to the given folder, including the properties, content, and all attachments. (note Only works if the store is in an authenticated state, otherwise this function leaves with KErrNotReady)

create new folder

creates new email template to drafts folder to be forwarded

Reads email from file stream and converts it to class CFSMailMessage

creates new email template into drafts folder

creates new email template to drafts folder to be replied

Returns the current synchronization state of mailbox.

deletes folder related to given folder id

removes mailbox

deletes email defined by message id

starts email parts fetching from email server

starts email fetching from email server

Returns branding id of this mailbox. This function is used by Branding Manager to associate mailbox to a branding definition. Plugin should return incoming mail server associated with this mailbox.

reads connection id from plugin

copies email part content to user given buffer

Returns last synchronization operation status.

returns mailbox online status

returns email object related to given message id

Retrieves a read-only file handle for the content file of this message part. Should return KErrNotSupported if handle can not be given directly. In that case FW will next ask to copy file to a temporary location so that FW can open the RFile itself. Ownership of the handle is transferred. Caller is responsible for closing the handle.

Get a list of most recently used addresses of desired mailbox. Each MRU entry consists of two descriptors placed sequentially in the array. First one is the display name and the second one is the actual email address. If for example some entry does not contain a name at all then a KNullDesC is found in place of the name.

The function will leave with KErrNotFound if a mailbox with given id is not found.

returns folder id of given standard folder

return folder id

Disables mailbox synchronization. Connection by the plugin to synchronize identified mailbox is not allowed after this.

If GoOnlineL has effect on other mailboxes of the same plugin then this function has effect on those mailboxes also.

MAILBOX HANDLING API Enables synchronization of identified mailbox. This means that the plugin can connect to server to do synchronization of the mailbox when necessary or stay connected all the time. The actual functionality depends on user settings and plugin implementation.

All collections (mail etc.) supported by the plugin and enabled by user settings are synchronized.

This function sets identified mailbox online but it may have a side effect that also other mailboxes of the same plugin are set online.

Connection is set offline normally by using specific function for this purpose. There are also other reasons for ending up in offline state like network error or scheduling.

checks from plugin if connection is allowed when roaming

list plugin implementations

lists existing mailboxes contained by plugin

MESSAGE FETCH AND STORE List messages contained by given folder. Returns email list iterator to user.

checks if mailbox supports given capability

Returns given message part. Ownership of object is transferred to caller.

return email part object, ownership is transferred to user

Moves a messages between the given folders.

Moves a messages between the given folders. Async version.

Creates and adds a new child part from file to given email part.

return new child part object, ownership is transferred to user

Creates and adds a new child part from file to given email part.

return new child part object, ownership is transferred to user

Creates and adds a new child part to given email part.

return new child part object, ownership is transferred to user

two-phased constructor

Forces synchronization of mailbox. This can be called whether the mailbox is currently offline or online. In case the mailbox is offline in the beginning, connection is made up for the time of the synchronization.

All collections (mail etc.) supported by the plugin and enabled by user settings are synchronized.

This is an asynchronous operation and the request id is returned for cancelling purpose.

Observer is given as a parameter to enable callbacks related to this operation. Alternatively user can use empty implementation of the observer function and rely only on events. Notice that the event system is not as comprehensive as the observing way do this.

Removes child part (and its children, if any) from given email part

Removes event observer

Removes fetched contents of these parts.

Search API Asyncronous call for starting search for given string. Only one search can be performed at a time.

This function will search for message's containing the given search string. The search will be performed on the all message fields: To, Cc, Bcc, subject, body. The search client will be notified of each found message, and upon completion of the search. Only one search can be performed at a time.

To change the sort order in the search result, use the same search string in the but change the aSortCriteria parameter. The store "caches" the search results generated by the same search string.

The function will leave with KErrInUse if a search is already in progress.

/note Only works if the store is in an authenticated state, otherwise this function leaves with KErrNotReady

aMailBoxId id of the mailbox where messages are to be searched

Launches email sending in plugin, cancellation is deleting the message from outbox.

stores email part content

sets authentication popup data

Sets the mailbox name for this mailbox.

Set a list of most recently used addresses for given mailbox. Each MRU entry consists of two descriptors placed sequentially in the array. First one is the display name and the second one is the actual email address. If for example some entry does not contain a name at all then a KNullDesC is found in place of the name.

The function will leave with KErrNotFound if a mailbox with given id is not found.

Sets email part contents from given file. Possible old contents are replaced.

Returns pending asynchronous request status, request is identified by request id if parallel requests exists

stores email object data to message store after modifications (commit)

stores email part object data to message store after modifications (commit)

Subscribes events coming from given mailbox. UnsubscribeMailboxEvents MUST be called before destroying given observer object.

unregisters request observer to cancel pending events

Unsubscribes events from given mailbox

Gives notification that new account data may be available from Email Wizard. Plugin must check if there is Wizard Data available for it and create new account if necessary. If plugin does not support Email Wizard this function can just return immediately.

Should return KErrNone if no data found or configuration was successful. otherwise any of the standard Symbian error codes.

instance identifier key for destructor