email/imum/Utils/Inc/ImumInSettingsKeys.h
branchRCL_3
changeset 27 7fdbb852d323
parent 0 72b543305e3a
equal deleted inserted replaced
26:ebe688cedc25 27:7fdbb852d323
       
     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:  ImumInSettingsKeys.h
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TIMUMINSETTINGSKEYS_H
       
    20 #define TIMUMINSETTINGSKEYS_H
       
    21 
       
    22 // Domain API contains the basic settings keys, so include header
       
    23 // automatically here.
       
    24 #include "ImumDaSettingsKeys.h"
       
    25 
       
    26 /** */
       
    27 const TInt KImumInSearchStringLength = 100;
       
    28 /** */
       
    29 const TInt KImumInSeparatorLength = 5;
       
    30 
       
    31 class TImumInSettings
       
    32     {
       
    33     public:
       
    34 
       
    35         /** */
       
    36         typedef TBuf8<KImumInSearchStringLength> TTextSearchString;
       
    37 
       
    38 
       
    39         // =========== KEY SETS ===========
       
    40 
       
    41         /** KEY SET: Connection settings */
       
    42         enum TInConnectionKeySet
       
    43             {
       
    44             /** TDesC */
       
    45             EKeyAccessPointName = 0x01010000,
       
    46 
       
    47             /** TInt */
       
    48             ELastInSettingsKey
       
    49             };
       
    50 
       
    51         /** KEY SET: Preferences */
       
    52         enum TPreferencesKeySet
       
    53             {
       
    54             /** Flags to control synchronization.
       
    55 
       
    56                 @type TInt
       
    57                 @see MImumInConnectionSettings
       
    58                 @see TDownloadSize */
       
    59             EKeySyncFlags = 0x02010000,
       
    60 
       
    61             /** Flags to control downloading.
       
    62 
       
    63                 @type TInt
       
    64                 @see MImumInConnectionSettings
       
    65                 @see TDownloadSize */
       
    66             EKeyDownloadFlags,
       
    67 
       
    68             /** Body size limit.
       
    69 
       
    70                 @type TInt32
       
    71                 @see MImumInConnectionSettings
       
    72                 @see TDownloadSize */
       
    73             EKeyDownloadBodySize,
       
    74 
       
    75             /** Attachment size limit.
       
    76 
       
    77                 @type TInt32
       
    78                 @see MImumInConnectionSettings
       
    79                 @see TDownloadSize */
       
    80             EKeyDownloadAttachmentSize,
       
    81 
       
    82             /** Maximum size of email that will be downloaded.
       
    83 
       
    84                 @type TInt
       
    85                 @see MImumInConnectionSettings
       
    86                 @see  */
       
    87             EKeyDownloadMaxEmailSize,
       
    88 
       
    89             /** TInt <NOT USED> */
       
    90             EKeyHideMsgs,
       
    91 
       
    92             /** TInt <NOT USED> */
       
    93             EKeyOpenHtmlMail,
       
    94 
       
    95 
       
    96             /** <NOT USED> */
       
    97             ELastInPreferenceKey
       
    98             };
       
    99 
       
   100         /** KEY SET: Miscellaneous */
       
   101         enum TMiscKeySet
       
   102             {
       
   103 
       
   104             /** IMAP4 related settings */
       
   105 
       
   106           	/** TDesC8 */
       
   107             EKeySearchString = 0x04010000,
       
   108 
       
   109           	/** TDesC8 */
       
   110             EKeyPathSeparator,
       
   111 
       
   112           	/** TInt */
       
   113             EKeySynchronise,
       
   114 
       
   115           	/** TInt */
       
   116             EKeySubscribe,
       
   117 
       
   118           	/** TInt */
       
   119             EKeyUpdatingSeenFlag,
       
   120 
       
   121           	/** TInt */
       
   122             EKeySyncRate,
       
   123 
       
   124           	/** TInt */
       
   125             EKeyFetchSize,
       
   126 
       
   127           	/** TInt */
       
   128             EKeyImapIdle,
       
   129 
       
   130           	/** TInt */
       
   131             EKeyImapIdleTimeout,
       
   132 
       
   133             /** TInt */
       
   134             EKeyDownloadBufferWlan,
       
   135 
       
   136             /** TInt */
       
   137             EKeyDownloadBufferGprs,
       
   138 
       
   139             /** SMTP related settings */
       
   140 
       
   141             /** TDesC */
       
   142             EKeyReceiptAddress,
       
   143 
       
   144             /** TInt */
       
   145             EKeyBodyEncoding,
       
   146 
       
   147             /** TInt32 */
       
   148             EKeyDefaultMsgCharSet,
       
   149 
       
   150             /** TInt */
       
   151             EKeyAddVCardToEmail,
       
   152 
       
   153             /** TInt */
       
   154             EKeyRequestReceipts,
       
   155 
       
   156             /** TInt */
       
   157             EKeySMTPAuth,
       
   158 
       
   159             /** TInt */
       
   160             EKeyInboxLoginDetails,
       
   161 
       
   162             /** TInt */
       
   163             EKeyToCcIncludeLimit,
       
   164 
       
   165             /** <NOT USED> */
       
   166             ELastInMiscKey       // Keep this last!
       
   167             };
       
   168 
       
   169         /** KEY SET: Email behaviour controlling keys */
       
   170         enum TEmailControlingKeySet
       
   171             {
       
   172             /** TInt */
       
   173             EKeyDisconnectedMode = 0x05010000,
       
   174 
       
   175 			/** TInt */
       
   176             EKeyAutoSendOnConnect,
       
   177 
       
   178 			/** TInt */
       
   179             EKeyDeleteEmailsWhenDisconnecting,
       
   180 
       
   181 			/** TInt */
       
   182             EKeyAcknowledgeReceipts,
       
   183 
       
   184 
       
   185             /** <NOT USED> */
       
   186             ELastEmailKey
       
   187             };
       
   188 
       
   189         /** KEY SET: Settings behaviour controlling keys */
       
   190         enum TControllingKeySet
       
   191             {
       
   192             /** TInt */
       
   193             EKeyTemporaryUsername = 0x0F000000,
       
   194             EKeyTemporaryPassword,
       
   195 
       
   196             /** TInt */
       
   197             EKeySettingsVersion,
       
   198 
       
   199             /** TInt */
       
   200             EKeyAllowEmptyEmailAddress,
       
   201 
       
   202             /** TInt */
       
   203             EKeyGenerateMailboxName,
       
   204 
       
   205             /** TInt */
       
   206             EKeyAccessPointType,
       
   207 
       
   208             /** TInt */
       
   209             EKeyInfoLastUpdateFailed,
       
   210 
       
   211             /** TInt64 */
       
   212             EKeyInfoLastSuccessfulUpdate,
       
   213 
       
   214             /** TInt */
       
   215             EKeyAoUpdateSuccessfulWithCurSettings,
       
   216 
       
   217             /** TBool */
       
   218             EKeyIsPredefinedMailbox,
       
   219 
       
   220             /** <NOT USED> */
       
   221             ELastControlKey
       
   222             };
       
   223 
       
   224         // =========== KEY VALUES ===========
       
   225 
       
   226         /** */
       
   227         enum TDownloadFlags
       
   228             {
       
   229             /** FLAGS */
       
   230             EFlagDownloadHeader             = 0x00000001,
       
   231             EFlagDownloadBody               = 0x00000002,
       
   232             EFlagDownloadBodyPartial        = 0x00000004,
       
   233             EFlagDownloadAttachment         = 0x00000008,
       
   234             EFlagDownloadAttachmentPartial  = 0x00000010,
       
   235             EFlagDownloadPartialCumulative  = 0x00000020,
       
   236 
       
   237             /** SETS */
       
   238             EFlagSetDownloadHeaderBody      = 0x00000003,
       
   239             EFlagSetDownloadAll             = 0x0000000B
       
   240             };
       
   241 
       
   242         /** */
       
   243         enum TDownloadSize
       
   244             {
       
   245             EValueDownloadCompletely     = -1,
       
   246             EValueDownloadUserDefined
       
   247             };
       
   248 
       
   249         /** */
       
   250         enum TBodyEncodingValues
       
   251             {
       
   252             EValueEncodingDefault = 0,
       
   253             EValueEncodingOff,
       
   254             EValueEncodingMIME,
       
   255             EValueEncodingMHtmlAsMime,
       
   256             EValueEncodingMHtmlAltAsMime
       
   257             };
       
   258 
       
   259         /** Access point types */
       
   260         enum TAccessPointControlValues
       
   261             {
       
   262             /** Index to the access point in the list */
       
   263             EValueApIsIapId = 0
       
   264             };
       
   265     };
       
   266 
       
   267 #endif // TIMUMINSETTINGSKEYS_H
       
   268 
       
   269 
       
   270