1 /*

     2 * Copyright (c) 2006 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:  Base email API factory

    15 *

    16 */

    17 

    18 

    19 #ifndef CIMUMINTERNALAPI_H

    20 #define CIMUMINTERNALAPI_H

    21 

    22 // INCLUDES

    23 #include <e32base.h>

    24 

    25 // Temporary

    26 #include <ImumInMailboxServices.h>

    27 #include <ImumInMailboxUtilities.h>

    28 #include <ImumInHealthServices.h>

    29 

    30 // CONSTANTS

    31 // MACROS

    32 // FORWARD DECLARATIONS

    33 class CImumInternalApi;

    34 class CMsvSession;

    35 class MImumInMailboxServices;

    36 class MImumInHealthServices;

    37 class MImumInMailboxUtilities;

    38 

    39 // LOCAL FUNCTION PROTOTYPES

    40 IMPORT_C CImumInternalApi* CreateEmailApiL( CMsvSession* aMsvSession = NULL );

    41 IMPORT_C CImumInternalApi* CreateEmailApiLC( CMsvSession* aMsvSession = NULL );

    42 

    43 // @deprecated

    44 typedef CImumInternalApi CIMAEmailApi;

    45 

    46 // DATA TYPES

    47 

    48 /**

    49 * Client side center point of email API

    50 *

    51 *

    52 * USAGE:

    53 *   Create object to email API by calling either CreateEmailApiL or

    54 *   CreateEmailApiLC. It's recommended, that the client provides the

    55 *   session to Message Server. For example:

    56 *       CImumInternalApi* emailApi = CreateEmailApiL( iMsvSession );

    57 *

    58 *   When finishing the usage of the API, simply delete the EmailApi object.

    59 *   For example:

    60 *       delete emailApi;

    61 *       emailApi = NULL;

    62 *

    63 * @lib ImumUtils.lib

    64 * @since S60 3.0

    65 */

    66 

    67 class CImumInternalApi : public CBase

    68 {

    69     public:

    70 

    71         enum TEmailFeatures

    72             {

    73             // Used when asking TARM status

    74             EMailLockedSettings = 0

    75             };

    76 

    77         virtual CMsvSession& MsvSession() = 0;

    78     

    79         /**

    80         * Interface to handle information regarding the healthiness of the mailboxes

    81         * @since S60 v3.2

    82         * @return Mailbox Doctor Interface

    83         */

    84         virtual const MImumInHealthServices& HealthServicesL() = 0;

    85         

    86         // @deprecated

    87         // For temporary use only

    88         virtual const MImumInHealthServices& HealthApiL() = 0;

    89                 

    90         virtual const MImumInMailboxServices& MailboxServicesL() = 0;

    91         

    92         virtual const MImumInMailboxUtilities& MailboxUtilitiesL() = 0;       

    93         

    94         /**

    95          * Function for checking mailbox flags and show information note. 

    96          * If resource parameters are set blank no note will be displayed.

    97          * @since S60 v3.2

    98          * @param Flag from the list TEmailFeatures.

    99          * @param aFeatureOnResource resource to be displayed if feature is on.

   100          * @param aFeatureOffResource resource to be displayed if feature is off.

   101          * @return ETrue if asked flag is active.

   102          */

   103         virtual TBool IsEmailFeatureSupportedL( 

   104             const TEmailFeatures aFlag ,

   105             const TUint aFeatureOnResource = 0,

   106             const TUint aFeatureOffResource = 0 ) = 0;         

   107 };

   108 

   109 

   110 

   111 #endif /* CIMUMINTERNALAPI_H */