harvesterplugins/messaging/email/inc/memailitemobserver.h
changeset 2 208a4ba3894c
child 3 6832643895f7
equal deleted inserted replaced
0:ccd0fd43f247 2:208a4ba3894c
       
     1 /*
       
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MEMAILITEMOBSERVER_H
       
    19 #define MEMAILITEMOBSERVER_H
       
    20 
       
    21 #include <e32base.h>
       
    22 #include <common.h>
       
    23 
       
    24 /**
       
    25  * @file 
       
    26  * @ingroup Email Plugin internal API
       
    27  * @brief Contains Interface to handle e-mail documents from e-mail fetcher
       
    28  */
       
    29 
       
    30 class CSearchDocument;
       
    31 
       
    32 /**
       
    33  * @brief The interface providing way to handle search document and update index database from action
       
    34  * @ingroup Email Plugin internal API
       
    35  * 
       
    36  * MEmailItemObserver provides callback to email plugin from email fetcher. 
       
    37  * 
       
    38  */
       
    39 class MEmailItemObserver
       
    40 {
       
    41 public:
       
    42 	    	
       
    43 	/**
       
    44 	 * A pure virtual method which is called by the email fetcher when it wants to send a document to
       
    45 	 * e-mail plugin for action on that document add/delete or update.
       
    46 	 *
       
    47 	 * @param aSearchDocument search document created by email fetcher
       
    48    * @param aActionType action to be taken on document
       
    49 	 */
       
    50 	virtual void HandleDocumentL(const CSearchDocument* aSearchDocument, TCPixActionType aActionType) = 0;
       
    51 
       
    52 };
       
    53 
       
    54 #endif // MEMAILITEMOBSERVER_H