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.

Children should overload to call CFSMailFolderBase::BlockMoveFromL() and CFSMailFolderBase::BlockCopyFromL() for the CFSMailFolder

Concrete plugins need to call the base plugin's implementation.

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

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 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)

creates new email template to drafts folder to be forwarded

Creates a forward/reply message via copying the original, using sender(s) as recipient(s).

Drafts folder assumed.

Create a MR reply message.

Relying on the UI for the subject and recipients.

Returns the current synchronization state of mailbox.

This methoed must be called before destruction of CBasePlugin derived class. To fix bug EIZU-7XVF2Z.

Note that as the msgstore performs the delete immediately the observer will get called from within this method.

The delete is executed asynchronously. The base plugin will queue the request and return immediately.

Note that aPreferredByteCount is ignored.

Async operation, starts fetching.

Finds the corresponding download request object for the part with id of aPartId identified by also the mailbox and the message ids.

Recursively looks for the part with id aPartId in the part container aParent.

Get MsgStore account object for the specified mailbox id.

Tries to find a body part of the specified content type. By default looks for the text/plain part.

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.

This method retrieves the specified message store message from a cache or directly from the message store if not cached. If the message was retrieved from the message store it is put into the cache. The lifetime of the message is managed by the cache but if a plugin makes a modification that would make the cached message invalid it must call the ResetCache method.

copies email part content to user given buffer

The delayed ops manager is used to queue asynchronous processing of plugin requests.

Note that the unseen count is not set by the plugin as this information is not readily available.

Returns last synchronization operation status.

Get MailBox address from protocol specific subclass. Caller is responsible for memory of returned string.

returns mailbox online status

Get the MsgStore mailbox instance for the specified FSEF mailbox id.

Get the MsgStore mailbox instance for the specified FSEF mailbox id.

The method will leave with KErrNotSupported if the msgstore is encrypted.

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.

Base plugin has no particular id.

Get reply-to address from protocol specific subclass. Caller is responsible for memory of returned string.

Get signature string from protocol specific subclass. Caller is responsible for memory of returned string.

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.

Applyed when an account was deleted for proper cleanup.

Called by RemovePartContentL for each part that needs its content removed.

lists existing mailboxes contained by plugin

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.

Create a new ChildPart using a file path

Create a new ChildPart using a file handle NOTE 1: RFs.ShareProtected() must have been called already before calling this method. NOTE 2: The ownersip of the RFile handle (aFile) is transferred to this method.

Helper method to avoid duplicated code

Used to refresh the cached mailbox display name, which can be changed by the user. The name is cached along with other mailbox info so that we can tell when it's changed in the message store and only notify the UI when such a change occurs.

RefreshCachedMailBoxDisplayNameL - This will check to see if the mailbox display name has changed. If so it will update the cached mailbox display name and set mailBoxNameHasChanged to ETrue

RefreshMailboxCacheL - This will refresh the mailbox instance cache maintained within the base plugin.

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

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

CFSMailPlugin::SendMessageL

Direct message sending that does not require having a FW message instance. The FW's SendMessageL method internally uses this method after translating the FW message to the MsgStore format.

Plugin could use this method to "send" a message if the CFSMailPlugin's is not necessary. The method also stores the message properties before doing so. This allows for optimizing away of unnecessary writes to the msgstore.

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.

When replying or forwarding a message determine the "To:" field's value.

If there is a reply to address, add it to the TO list else add the FROM address to the TO address list

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

Goes through all the part props and stores them in the msg store.

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

Translates a message in Freestyle format to the common Message Store format. Does not store the destination's properties in the msgstore. The caller must call StorePropertiesL when necessary. This way writes to the message store can be minimized.

Day of week translator from the MsgStore to the FS format. The actual translation step is supplied via the day of week ftor. See CDayOfWeekFtor for further information. Although not strictly necessary this avoids duplicating all the if's when dealing with rule translation.

Translates common message store meeting requests into Freestyle mr info objects. Sync plugins might be interested in extending the default behavior.

Common msgstore meeting request fields translation to Freestyle.

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.