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: Email mailbox setting key definitions for IMAP4/POP3

    15 *

    16 */

    17 

    18 #ifndef IPSSETTINGKEYS_H

    19 #define IPSSETTINGKEYS_H

    20 

    21 namespace IpsServices {

    22     

    23 // Value from ipssosplugin

    24 static const quint32 EmailMailboxSettingRepository = 0x2000E53D; 

    25 

    26 

    27 

    28 // Key offsets are defined here:

    29 

    30 // EmailMailboxOffset defines key offset between mailboxes in the repository.

    31 // For example mailboxId key for each mailbox is calculated by the following formula:

    32 // key = mailboxNumber (starting from 1) * EmailMailboxOffset + EmailKeyMailboxId

    33 // (1st mailbox = 1 * 0x1000 + 0 = 0x1000)

    34 // This allows key range 0-0x0FFF to contain mailbox independent keys.

    35 static const quint32 EmailMailboxOffset = 0x1000;

    36 

    37 // Offsets for sync profiles keys.

    38 // Keep-Up-To-Date

    39 static const quint32 EmailProfileOffsetKUTD = 0x0;

    40 

    41 // Save Energy

    42 static const quint32 EmailProfileOffsetSE = 0x100;

    43 

    44 // Manual Fetch

    45 static const quint32 EmailProfileOffsetMF = 0x200;

    46 

    47 // User Defined profile (for future use)

    48 static const quint32 EmailProfileOffsetUD = 0x300;

    49 

    50 

    51 // Key definitions are defined here:

    52 

    53 // Mailbox id. This is a 32-bit integer excluding the protocol plug-in id.

    54 static const quint32 EmailKeyMailboxId = 0;

    55 

    56 // Preferences keys:

    57 

    58 // Is automatic picture downloading enabled (0=Off,1=On)

    59 static const quint32 EmailKeyPreferenceDownloadPictures = 1;

    60 

    61 // Defines if message divider is shown in message list.

    62 // Values: 0=Divider not shown, 1=1ivider is shown

    63 static const quint32 EmailKeyPreferenceMessageDivider = 2;

    64 

    65 // Currently used sync profile 

    66 //  Keep Up-to-Date (=KUTD) / Save Energy (=SE) / Manual Fetch (=MF) / User defined (=UD)

    67 //  Keep Up-to-Date  = 0 (EmailProfileOffsetKUTD)

    68 //  Save Energy      = 1 (EmailProfileOffsetSE)

    69 //  Manual Fetch     = 2 (EmailProfileOffsetMF)

    70 //  User Defined     = 3 (EmailProfileOffsetUD)     (<== for future use) 

    71 //  (Could EMN be one value when taken in use)

    72 static const quint32 EmailKeyReceptionActiveProfile = 3;

    73 

    74 // Reception schedule keys. To calculate the actual key, use EmailProfileOffset<profile>.

    75 // For example to determine inbox sync window key for the 'Save energy' profile:

    76 // key = mailbox number (e.g. 1) * EmailMailboxOffset (0x1000) +

    77 //       EmailKeyReceptionInboxSyncWindow (5) +

    78 //       EmailProfileOffsetSE (0x100)

    79 //       = 0x1105

    80 

    81 // This is reserved for future use!

    82 // State of "User defined receive profile" (1=Enabled,0=Disabled) affects

    83 // visibility of the user defined profile. The profile is enabled in a mailbox

    84 // once user changes any 'receive setting'.

    85 static const quint32 EmailKeyReceptionUserDefinedProfile = 4;

    86 

    87 // Inbox sync window in number of messages. 0 means all messages are synched

    88 // from the server. 

    89 // Value for each profile: KUTP(200),SE(100),FM(100), UD

    90 // This key follows the profile offset.

    91 static const quint32 EmailKeyReceptionInboxSyncWindow = 5;

    92 

    93 // default values for each profile

    94 static const int DefaultValueKeepUpToDateInboxSyncWindow = 200;

    95 static const int DefaultValueSaveEnergyInboxSyncWindow = 100;

    96 static const int DefaultValueManualSyncInboxSyncWindow = 100;

    97 static const int DefaultUserDefinedInboxSyncWindow = -1;

    98 

    99 // Other folder sync window in number of messages. 0 means all messages are synched

   100 // from the server.               

   101 // This key follows the profile offset.

   102 static const quint32 EmailKeyReceptionGenericSyncWindowInMessages = 6;

   103                 

   104 // Receiving weekdays: list of days as a bit flag (integer).

   105 // 0x01 = Mon, 0x02 = Tue, 0x04 = Wed, 0x08 = Thu, 0x10 = Fri, 0x20 = Sat, 0x40 = Sun

   106 // Value for each profile: KUTP(0x7F), SE(0x7F), MF(-1=N/A), UD

   107 // This key follows the profile offset.

   108 static const quint32 EmailKeyReceptionWeekDays = 7;

   109 

   110 // default values for each profile

   111 static const int DefaultValueKeepUpToDateReceptionDays = 0x7F;

   112 static const int DefaultValueSaveEnergyReceptionDays = 0x7F;

   113 static const int DefaultValueManualSyncReceptionDays = -1;

   114 static const int DefaultUserDefinedReceptionDays = -1;

   115 

   116 // Receive start time. Value 00am – 12pm (integer 0-23).

   117 // Value for each profile: KUTP(8), SE(8), MF(-1=N/A), UD

   118 // This key follows the profile offset.

   119 static const quint32 EmailKeyReceptionDayStartTime = 8;

   120 

   121 // default values for each profile

   122 static const int DefaultValueKeepUpToDateReceptionStartTime = 8;

   123 static const int DefaultValueSaveEnergyReceptionStartTime = 8;

   124 static const int DefaultValueManualSyncReceptionStartTime = -1;

   125 static const int DefaultUserDefinedReceptionStartTime = -1;

   126 

   127 // Receive end time. Value 00am – 12pm (integer 0-23).

   128 // Value for each profile: KUTP(22), SE(22), MF(-1=N/A), UD

   129 // This key follows the profile offset.

   130 static const quint32 EmailKeyReceptionDayEndTime = 9;

   131 

   132 // default values for each profile

   133 static const int DefaultValueKeepUpToDateReceptionEndTime = 22;

   134 static const int DefaultValueSaveEnergyReceptionEndTime = 22;

   135 static const int DefaultValueManualSyncReceptionEndTime = -1;

   136 static const int DefaultUserDefinedReceptionEndTime = -1;

   137 

   138 // Refresh mail, during daytime

   139 // Integer x minutes [possible values are 5, 15, 60, 240, 0 = "when open mailbox"].

   140 // Value for each profile: KUTP(5), SE(60), MF(-1=N/A), UD

   141 // This key follows the profile offset.

   142 static const quint32 EmailKeyReceptionRefreshPeriodDayTime = 10;

   143 

   144 // default values for each profile

   145 static const int DefaultValueKeepUpToDateReceptionRefreshPeriodDayTime = 5;

   146 static const int DefaultValueSaveEnergyReceptionRefreshPeriodDayTime = 60;

   147 static const int DefaultValueManualSyncReceptionRefreshPeriodDayTime = -1;

   148 static const int DefaultUserDefinedReceptionRefreshPeriodDayTime = -1;

   149 

   150 // Refresh during other times.

   151 // Integer x minutes [possible values 5, 15, 60, 240, 0 = "when open mailbox"].

   152 // This key follows the profile offset.

   153 static const quint32 EmailKeyReceptionRefreshPeriodOther = 11;

   154 

   155 // End of reception schedule keys

   156 

   157 

   158 // Defines if user name for particular mailbox is hidden.

   159 static const quint32 EmailKeyUserNameHidden = 20;

   160 

   161 } // namespace

   162 

   163 #endif //IPSSETTINGKEYS_H