1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/app/imapset.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,708 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __IMAPSET_H__
1.20 +#define __IMAPSET_H__
1.21 +
1.22 +
1.23 +
1.24 +
1.25 +#include <msvuids.h>
1.26 +#include <miutset.h>
1.27 +
1.28 +class TBearerTypes;
1.29 +class TImImap4GetPartialMailInfo;
1.30 +
1.31 +/** Default IMAP4 server port number. */
1.32 +const TUint32 KIMAPDefaultPortNumber = 143;
1.33 +
1.34 +/** Default inbox refresh rate in seconds. */
1.35 +const TInt KImapDefaultInboxSyncRate = 300;
1.36 +
1.37 +/** Default idle timeout in seconds. */
1.38 +const TInt KImapDefaultIdleTimeout = 1740;
1.39 +
1.40 +/** Default fetch size in bytes. */
1.41 +const TUint KImapDefaultFetchSizeBytes = 20480;
1.42 +
1.43 +
1.44 +
1.45 +/** @deprecated */
1.46 +const TInt32 KImImapSynchroniseAll = -1;
1.47 +
1.48 +/** @deprecated */
1.49 +const TInt32 KImImapSynchroniseNone = 0;
1.50 +
1.51 +
1.52 +/**
1.53 +Describes the folder subscription synchronisation strategy.
1.54 +
1.55 +This specifies whether the local or remote folder subscription flags, or a
1.56 +combination of both, are used to determine which mailboxes are synchronised.
1.57 +For an overview of the synchronisation process, see CImap4ClientMtm.
1.58 +
1.59 +@see CImImap4Settings::SetSynchronise()
1.60 +@see CImImap4Settings::Synchronise()
1.61 +
1.62 +@publishedAll
1.63 +@released
1.64 +*/
1.65 +enum TFolderSyncType
1.66 + {
1.67 + /** Folders that are marked for subscription either locally or remotely are synchronised. */
1.68 + EUseCombination=0,
1.69 + /** Only folders marked for subscription locally are synchronised. */
1.70 + EUseLocal,
1.71 + /** Only folders marked for subscription remotely are synchronised. */
1.72 + EUseRemote
1.73 + };
1.74 +
1.75 +
1.76 +/**
1.77 +Specifies methods of synchronising IMAP4 subscription information with a server.
1.78 +
1.79 +Subscription settings that have been set on folders on the local device, and
1.80 +subscription settings that have been set on the corresponding mailboxes on the
1.81 +remote server can be synchronised, as part of the synchronisation process
1.82 +(see the overview for CImap4ClientMtm).
1.83 +
1.84 +@see CImImap4Settings::SetSubscribe()
1.85 +@see CImImap4Settings::Subscribe()
1.86 +
1.87 +@publishedAll
1.88 +@released
1.89 +*/
1.90 +enum TFolderSubscribeType
1.91 + {
1.92 + /** Do not alter local or remote subscription information. */
1.93 + EUpdateNeither=0,
1.94 + /** Update local copy of subscription information when it is received from the
1.95 + remote IMAP4 server at the beginning of the mail session. */
1.96 + EUpdateLocal,
1.97 + /** Update remote copy of subscription information so that it matches the local
1.98 + subscription information. */
1.99 + EUpdateRemote,
1.100 + /** Merge local and remote subscription information, store updated information
1.101 + on the remote server and store merged data on the local message store. */
1.102 + EUpdateBoth
1.103 + };
1.104 +
1.105 +
1.106 +/**
1.107 +Defines which components of a message to fetch when copying or moving from
1.108 +a server.
1.109 +
1.110 +@see CImImap4Settings::SetGetMailOptions()
1.111 +@see CImImap4Settings::GetMailOptions()
1.112 +
1.113 +@publishedAll
1.114 +@released
1.115 +*/
1.116 +enum TImap4GetMailOptions
1.117 + {
1.118 + /** Get message headers. */
1.119 + EGetImap4EmailHeaders,
1.120 + /** Get message body. */
1.121 + EGetImap4EmailBodyText,
1.122 + /** Get message body and attachments. */
1.123 + EGetImap4EmailBodyTextAndAttachments,
1.124 + /** Get message attachments. */
1.125 + EGetImap4EmailAttachments,
1.126 + /** Get message body, including non-plain or non-HTML alternative text parts (or attachments). */
1.127 + EGetImap4EmailBodyAlternativeText
1.128 + };
1.129 +
1.130 +/**
1.131 +Defines which components of a message should be fetched partially when
1.132 +fetching the message from a server.
1.133 +
1.134 +@see
1.135 +CImImap4Settings
1.136 +
1.137 +@publishedAll
1.138 +@released
1.139 +*/
1.140 +enum TImImap4PartialMailOptions
1.141 + {
1.142 + /** No size limits, full message to be fetched.*/
1.143 + ENoSizeLimits,
1.144 + /** Get body text only.
1.145 + Gets text/plain part only if text/plain part size + text/html part size
1.146 + is greater than body text size limit.
1.147 + Gets text/plain part and text/html part if text/plain part size + text/html part size
1.148 + is less than body text size limit of the message.*/
1.149 + EBodyTextOnly,
1.150 + /** Gets all the attachments less than attachment size limit.*/
1.151 + EAttachmentsOnly,
1.152 + /** Gets the body text less than or equal to body text size limit and attachments
1.153 + less than or equal to attachment size limit.*/
1.154 + EBodyTextAndAttachments,
1.155 + /** Gets the body text less than total size limit and also attachments whose size
1.156 + is within total size limit minus fetched body parts.*/
1.157 + ECumulative,
1.158 + /** Gets the body text less than total size limit and all non-HTML text attachments whose size
1.159 + is within total size limit minus fetched body parts.*/
1.160 + EBodyAlternativeText
1.161 + };
1.162 +
1.163 +/**
1.164 +Flags to indicate what type of IMAP4 progress information is being returned.
1.165 +
1.166 +@publishedAll
1.167 +@released
1.168 +*/
1.169 +enum TImap4ProgressType
1.170 + {
1.171 + /** Progress information is an TImap4GenericProgress object. */
1.172 + EImap4GenericProgressType,
1.173 + /** Progress information is an TImap4SyncProgress object. */
1.174 + EImap4SyncProgressType
1.175 + };
1.176 +
1.177 +
1.178 +class TImap4GenericProgress
1.179 +/**
1.180 +Progress information for an IMAP4 get operation.
1.181 +
1.182 +For the 'get mail when already connected' operations, the progress state can
1.183 +be obtained from TImap4GenericProgress::iState. In the case of the 'connect
1.184 +and get mail and disconnect' and 'connect and get mail and stay online', the
1.185 +actual progress defined in TImap4GenericProgress::iState will be of the form
1.186 +of 'Copy New Mail', 'Populating Message Selection' etc. The sub-operation
1.187 +state can then be obtained in the form of 'Connecting', 'Fetching', 'Disconnecting'
1.188 +etc. from TImap4GenericProgress::iImap4SubStateProgress.
1.189 +
1.190 +@see
1.191 +CImImap4GetMail
1.192 +
1.193 +@publishedAll
1.194 +@released
1.195 +*/
1.196 + {
1.197 +public:
1.198 + IMPORT_C TInt ConnectionState() const;
1.199 + IMPORT_C TInt ConnectionIAP() const;
1.200 +
1.201 +public:
1.202 + /** Operation type. */
1.203 + enum TImap4GenericProgressOp
1.204 + {
1.205 + /** Connect operation. */
1.206 + EConnect,
1.207 + /** Disconnect operation. */
1.208 + EDisconnect,
1.209 + /** Sync operation. */
1.210 + ESync,
1.211 + /** Select operation. */
1.212 + ESelect,
1.213 + /** Copy messages to local operation. */
1.214 + ECopyToLocal,
1.215 + /** Copy messages within remote server operation. */
1.216 + ECopyWithinService,
1.217 + /** Copy messages from local operation. */
1.218 + ECopyFromLocal,
1.219 + /** Move messages to local operation. */
1.220 + EMoveToLocal,
1.221 + /** Move messages within remote server operation. */
1.222 + EMoveWithinService,
1.223 + /** Move messages from local operation. */
1.224 + EMoveFromLocal,
1.225 + /** Message population operation. */
1.226 + EPopulate,
1.227 + /** Delete operation. */
1.228 + EDelete,
1.229 + /** Offline delete operation. */
1.230 + EOffLineDelete,
1.231 + /** Offline undelete operation. */
1.232 + EOffLineUndelete,
1.233 + /** Offline delete operation. */
1.234 + EOffLineCopyToLocal,
1.235 + /** Offline move messages to local operation. */
1.236 + EOffLineMoveToLocal,
1.237 + /** Offline copy messages from local operation. */
1.238 + EOffLineCopyFromLocal,
1.239 + /** Offline move messages from local operation. */
1.240 + EOffLineMoveFromLocal,
1.241 + /** Offline copy messages within remote server operation. */
1.242 + EOffLineCopyWithinService,
1.243 + /** Offline move messages within remote server operation. */
1.244 + EOffLineMoveWithinService,
1.245 + /** Offline message population operation. */
1.246 + EOffLinePopulate
1.247 + };
1.248 +
1.249 + /** Operation state information. */
1.250 + enum TImap4GenericProgressState
1.251 + {
1.252 + /** Disconnected. */
1.253 + EDisconnected,
1.254 + /** Connecting. */
1.255 + EConnecting,
1.256 + /** Idle. */
1.257 + EIdle,
1.258 + /** Selecting the folder to use. */
1.259 + ESelecting,
1.260 + /** Fetching messages to mirror server. */
1.261 + EFetching,
1.262 + /** Appending local messages to remote server. */
1.263 + EAppending,
1.264 + /** Copying local messages to local or within service. */
1.265 + ECopying,
1.266 + /** Deleting an item, including expunging a folder. */
1.267 + EDeleting,
1.268 + /** Synchronising folder after an operation. */
1.269 + ESyncing,
1.270 + /** Disconnecting. */
1.271 + EDisconnecting,
1.272 + /** Sync already in progress. */
1.273 + EBusy,
1.274 + /** CImImap4GetMail move operation in progress. */
1.275 + EMoving,
1.276 + /** CImImap4GetMail copy new mail operation in progress. */
1.277 + ECopyNewMail,
1.278 + /** CImImap4GetMail move new mail operation in progress. */
1.279 + EMoveNewMail,
1.280 + /** CImImap4GetMail copy selected messages operation in progress. */
1.281 + ECopyMailSelection,
1.282 + /** CImImap4GetMail move selected messages operation in progress. */
1.283 + EMoveMailSelection,
1.284 + /** CImImap4GetMail copy all messages operation in progress. */
1.285 + ECopyAllMail,
1.286 + /** CImImap4GetMail move all messages operation in progress. */
1.287 + EMoveAllMail,
1.288 + /** CImImap4GetMail populate new messages operation in progress. */
1.289 + EPopulateNewMail,
1.290 + /** CImImap4GetMail populate all messages operation in progress. */
1.291 + EPopulateAllMail,
1.292 + /** CImImap4GetMail populate selected messages operation in progress. */
1.293 + EPopulateMailSelection
1.294 + };
1.295 +
1.296 + /** Progress information type: always EImap4GenericProgressType. */
1.297 + TImap4ProgressType iType;
1.298 + /** Operation type. */
1.299 + TImap4GenericProgressOp iOperation;
1.300 + /**
1.301 + The progress state.
1.302 +
1.303 + For 'connect and get mail and disconnect' and 'connect and get mail and stay
1.304 + online' type operations, additional sub-operation state can be obtained from
1.305 + iImap4SubStateProgress.
1.306 + */
1.307 + TImap4GenericProgressState iState;
1.308 + /**
1.309 + The progress sub-state.
1.310 +
1.311 + This only applies to 'connect and get mail and disconnect' and 'connect and
1.312 + get mail and stay online' type operations.
1.313 + */
1.314 + TImap4GenericProgressState iImap4SubStateProgress;
1.315 + /** In the EConnecting state, this field holds the connection iap value,
1.316 + otherwise it holds the number of messages still to be processed. */
1.317 + TInt iMsgsToDo;
1.318 + /** In the EConnecting state, this field holds the connection stage value,
1.319 + otherwise it holds the number of messages processed. */
1.320 + TInt iMsgsDone;
1.321 + /** Number of message parts still to be processed. */
1.322 + TInt iPartsToDo;
1.323 + /** Number of message parts processed. */
1.324 + TInt iPartsDone;
1.325 + /** Number of bytes (for a multipart fetch) still to be processed. */
1.326 + TInt iBytesToDo;
1.327 + /** Number of bytes (for a multipart fetch) processed. */
1.328 + TInt iBytesDone;
1.329 + /** Error code. */
1.330 + TInt iErrorCode;
1.331 + /** Message ID returned from the operation. */
1.332 + TMsvId iReturnedMsvId;
1.333 + /** The total size of messages to be downloaded (bytes). */
1.334 + TInt iTotalSize;
1.335 + };
1.336 +
1.337 +
1.338 +class TImap4SyncProgress
1.339 +/**
1.340 +IMAP4 synchronisation progress information.
1.341 +
1.342 +The client may then use an object of this type created by the server MTM to
1.343 +track synchronisation progress.
1.344 +
1.345 +@publishedAll
1.346 +@released
1.347 +*/
1.348 + {
1.349 +public:
1.350 + /** Synchronisation state. */
1.351 + enum TImap4SyncProgressState
1.352 + {
1.353 + /** Idle. */
1.354 + EIdle,
1.355 + /** Busy. */
1.356 + EBusy,
1.357 + /** Connecting. */
1.358 + EConnecting,
1.359 + /** Disconnecting. */
1.360 + EDisconnecting,
1.361 + /** Synchronising inbox. */
1.362 + ESyncInbox,
1.363 + /** Synchronising folder tree. */
1.364 + ESyncFolderTree,
1.365 + /** Checking remote subscription. */
1.366 + ECheckRemoteSubscription,
1.367 + /** Updating remote subscription. */
1.368 + EUpdateRemoteSubscription,
1.369 + /** Synchronising other information. */
1.370 + ESyncOther,
1.371 + /** Deleting. */
1.372 + EDeleting,
1.373 + /** Processing pending operations. */
1.374 + EProcessingPendingOps
1.375 + };
1.376 +
1.377 + /** Progress information type: always EImapSyncProgressType. */
1.378 + TImap4ProgressType iType;
1.379 + /** Synchronisation state. */
1.380 + TImap4SyncProgressState iState; // Where is the sync up to?
1.381 + /**
1.382 + "Folders to do" count for synchronisation.
1.383 + This is meaningful during the #ESyncOther and #EDeleting
1.384 + synchronisation stages.
1.385 + */
1.386 + TInt iFoldersToDo;
1.387 + /**
1.388 + "Folders done" count for synchronisation.
1.389 + This is meaningful during the #ESyncOther and #EDeleting
1.390 + synchronisation stages.
1.391 + */
1.392 + TInt iFoldersDone;
1.393 + /**
1.394 + "Message to do" count for synchronisation.
1.395 + This is meaningful during the #ESyncInbox, #ESyncOther and #EProcessingPendingOps
1.396 + synchronisation stages.
1.397 + */
1.398 + TInt iMsgsToDo;
1.399 + /**
1.400 + "Message done" count for synchronisation.
1.401 + This is meaningful during the #ESyncInbox, #ESyncOther and #EProcessingPendingOps
1.402 + synchronisation stages.
1.403 + */
1.404 + TInt iMsgsDone;
1.405 + /**
1.406 + Number of headers fetched during synchronisation.
1.407 + */
1.408 + TInt iHeadersFetched;
1.409 + /**
1.410 + Number of folders orphaned during synchronisation.
1.411 +
1.412 + An orphaned folder is a local folder which existed
1.413 + under the service, but which did not exist
1.414 + on the remote server when synchronisation was done.
1.415 + */
1.416 + TInt iOrphanedFolders;
1.417 + /**
1.418 + Number of new folders during synchronisation.
1.419 + */
1.420 + TInt iNewFolders;
1.421 + /**
1.422 + Number of orphaned messages during synchronisation.
1.423 +
1.424 + An orphaned message is one which existed locally
1.425 + under the service, but which did not exist
1.426 + on the remote server when synchronisation was done.
1.427 + */
1.428 + TInt iOrphanedMessages;
1.429 + /**
1.430 + Number of remote messages tagged for deletion.
1.431 +
1.432 + In IMAP, messages can be flagged as deleted, before
1.433 + they are later permanently removed.
1.434 + */
1.435 + TInt iRemoteMessagesDeleteTagged;
1.436 + /** Number of messages fetched during synchronisation.
1.437 +
1.438 + In the current implementation, this is always 0. Use
1.439 + iHeadersFetched to get the number of headers fetched.
1.440 + */
1.441 + TInt iMessagesFetchedOK;
1.442 + /** Number of message parts fetched during synchronisation.
1.443 +
1.444 + In the current implementation, this is always 0.
1.445 + */
1.446 + TInt iMessagePartsFetchedOK;
1.447 + /** Number of message parts not found during synchronisation.
1.448 +
1.449 + In the current implementation, this is always 0.
1.450 + */
1.451 + TInt iMessagePartsNotFound;
1.452 + /** Number of folders not found during synchronisation.
1.453 +
1.454 + This can occur if the remote server returns an error when
1.455 + a client attempts to select a folder during synchronisation.
1.456 + */
1.457 + TInt iFoldersNotFound;
1.458 + /** Any error-code that the client needs to be informed of. */
1.459 + TInt iErrorCode;
1.460 + };
1.461 +
1.462 +class TImap4CompoundProgress
1.463 +/**
1.464 +IMAP operation progress information.
1.465 +
1.466 +The class supplies both the two IMAP progress types, generic and synchronisation.
1.467 +
1.468 +The IMAP4 server MTM owns two IMAP4 sessions that are used independently of
1.469 +each other to perform 'background' and 'foreground' operations. In a typical
1.470 +situation, the user may be downloading the body parts of a message (populating)
1.471 +in the foreground whilst in the background a full synchronisation may be underway.
1.472 +In this scenario, the generic progress will give an indication of the 'foreground'
1.473 +activity and the synchronisation progress will give an indication of the 'background'
1.474 +progress. The synchronisation progress component of the compound progress
1.475 +will always show the synchronisation progress irrespective of whether the
1.476 +synchronisation is running in the foreground or the background.
1.477 +
1.478 +@publishedAll
1.479 +@released
1.480 +*/
1.481 + {
1.482 +public:
1.483 + /** Generic progress. */
1.484 + TImap4GenericProgress iGenericProgress;
1.485 + /** Synchronisation progress. */
1.486 + TImap4SyncProgress iSyncProgress;
1.487 + };
1.488 +
1.489 +
1.490 +class CImImap4Settings : public CImBaseEmailSettings
1.491 +/**
1.492 +Settings for connection to and use of an IMAP4 mail server and its mailboxes.
1.493 +
1.494 +Messaging clients should use an instance of this class to specify and retrieve
1.495 +configuration settings that are used by an IMAP4 service when executing email
1.496 +operations.
1.497 +
1.498 +Service settings include:
1.499 +
1.500 +- server log on settings (user name and password)
1.501 +- message header synchronisation strategy and synchronisation limits
1.502 +- message getting options, such as maximum size. Note that these options
1.503 + are not used by the IMAP MTM. They can be used by client applications to
1.504 + store user preferences, and be used by the client when issuing get commands.
1.505 +- miscelleanous settings, including whether IMAP IDLE should be used
1.506 +
1.507 +CImImap4Settings objects are created and accessed through
1.508 +CEmailAccounts. CEmailAccounts can also be used to get the
1.509 +connection settings, such as the ISP to use, used to access an IMAP server.
1.510 +
1.511 +Settings for a service are associated with a service-type entry in the Message
1.512 +Server'smessage store. However the settings are not actually stored in the
1.513 +message store, but in the device's Central Repository data store.
1.514 +
1.515 +@see CEmailAccounts
1.516 +
1.517 +@publishedAll
1.518 +@released
1.519 +*/
1.520 + {
1.521 +public:
1.522 + IMPORT_C CImImap4Settings();
1.523 + IMPORT_C virtual ~CImImap4Settings();
1.524 + IMPORT_C void Reset();
1.525 + IMPORT_C const TPtrC8 LoginName() const;
1.526 + IMPORT_C void SetLoginNameL(const TDesC8& aLoginName);
1.527 + IMPORT_C const TPtrC8 Password() const;
1.528 + IMPORT_C void SetPasswordL(const TDesC8& aPassword);
1.529 + IMPORT_C const TPtrC8 FolderPath() const;
1.530 + IMPORT_C void SetFolderPathL(const TDesC8& aFolderPath);
1.531 + IMPORT_C const TPtrC8 SearchString() const;
1.532 + IMPORT_C void SetSearchStringL(const TDesC8& aSearchString);
1.533 + IMPORT_C TText8 PathSeparator() const;
1.534 + IMPORT_C void SetPathSeparator(const TText8 aPathSeparator);
1.535 + IMPORT_C TBool DisconnectedUserMode() const;
1.536 + IMPORT_C void SetDisconnectedUserMode(TBool aFlag);
1.537 + IMPORT_C void SetSynchronise(const TFolderSyncType aType);
1.538 + IMPORT_C TFolderSyncType Synchronise() const;
1.539 + IMPORT_C void SetSubscribe(const TFolderSubscribeType aType);
1.540 + IMPORT_C TFolderSubscribeType Subscribe() const;
1.541 + IMPORT_C TBool AutoSendOnConnect() const;
1.542 + IMPORT_C void SetAutoSendOnConnect(TBool aFlag);
1.543 + IMPORT_C TUint MaxEmailSize() const;
1.544 + IMPORT_C void SetMaxEmailSize(const TUint aMaxEmailSize);
1.545 + IMPORT_C TBool DeleteEmailsWhenDisconnecting() const;
1.546 + IMPORT_C void SetDeleteEmailsWhenDisconnecting(TBool aFlag);
1.547 + IMPORT_C TBool AcknowledgeReceipts() const;
1.548 + IMPORT_C void SetAcknowledgeReceipts(TBool aFlag);
1.549 + IMPORT_C TImap4GetMailOptions GetMailOptions() const;
1.550 + IMPORT_C void SetGetMailOptions(TImap4GetMailOptions aGetMailOptions);
1.551 + IMPORT_C CImImap4Settings& CopyL(const CImImap4Settings& aCImImap4Settings);
1.552 + IMPORT_C TBool operator==(const CImImap4Settings& aCImImap4Settings) const;
1.553 + IMPORT_C TInt32 InboxSynchronisationLimit() const;
1.554 + IMPORT_C void SetInboxSynchronisationLimit(const TInt32 aInboxSyncLimit);
1.555 + IMPORT_C TInt32 MailboxSynchronisationLimit() const;
1.556 + IMPORT_C void SetMailboxSynchronisationLimit(const TInt32 aMailboxSyncLimit);
1.557 + IMPORT_C TBool UpdatingSeenFlags() const;
1.558 + IMPORT_C void SetUpdatingSeenFlags(TBool aFlag);
1.559 + IMPORT_C TInt SyncRate() const;
1.560 + IMPORT_C void SetSyncRateL(TInt aSyncRate);
1.561 + IMPORT_C TUint FetchSize() const;
1.562 + IMPORT_C void SetFetchSizeL(TUint aFetchSizeBytes);
1.563 + IMPORT_C TBool ImapIdle() const;
1.564 + IMPORT_C void SetImapIdle(TBool aFlag);
1.565 + IMPORT_C TInt ImapIdleTimeout() const;
1.566 + IMPORT_C void SetImapIdleTimeoutL(TInt aIdleTimeout);
1.567 + IMPORT_C TImImap4PartialMailOptions PartialMailOptions() const;
1.568 + IMPORT_C void SetPartialMailOptionsL(TImImap4PartialMailOptions aPartialMailOptions);
1.569 + IMPORT_C TInt32 BodyTextSizeLimit() const;
1.570 + IMPORT_C void SetBodyTextSizeLimitL(TInt32 aBodyTextSizeLimit);
1.571 + IMPORT_C TInt32 AttachmentSizeLimit() const;
1.572 + IMPORT_C void SetAttachmentSizeLimitL(TInt32 aAttachmentSizeLimit);
1.573 + IMPORT_C TBool UseExpunge() const;
1.574 + IMPORT_C void SetUseExpunge(TBool aFlag);
1.575 + IMPORT_C void SetTlsSslDomainL(const TDesC8& aDomainName);
1.576 + IMPORT_C TPtrC8 TlsSslDomain() const;
1.577 + IMPORT_C void SetUseSyncDownloadRules(TBool aFlag);
1.578 + IMPORT_C TBool UseSyncDownloadRules();
1.579 + IMPORT_C void SetFolderSyncDisabled(TBool aFlag);
1.580 + IMPORT_C TBool FolderSyncDisabled();
1.581 +
1.582 +private:
1.583 + class TImImap4SettingsExtension
1.584 + {
1.585 + public:
1.586 + inline TImImap4SettingsExtension();
1.587 + public:
1.588 + HBufC8* iLoginName;
1.589 + HBufC8* iPassword;
1.590 + HBufC8* iFolderPath;
1.591 + HBufC8* iSearchString;
1.592 + HBufC8* iTlsSslDomain;
1.593 + TInt iSyncRate;
1.594 + TInt iImapIdleTimeout;
1.595 + TUint iFetchSizeBytes;
1.596 + TImImap4PartialMailOptions iPartialMailOptions;
1.597 + TInt32 iBodyTextSizeLimit;
1.598 + TInt32 iAttachmentSizeLimit;
1.599 + };
1.600 +
1.601 + inline TImImap4SettingsExtension* Extension() const;
1.602 + inline void CheckExtensionExistsL();
1.603 +
1.604 + enum TImImap4EmailSettings
1.605 + {
1.606 + KImap4EmailSettingsClearFlag = 0x00000000,
1.607 + KImap4BaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag, //0x00000002
1.608 + KImap4EmailDisconnectedModeFlag = KImap4BaseEmailSettingsLastUsedFlag << 1, //0x00000004
1.609 + KImap4EmailAutoSendFlag = KImap4EmailDisconnectedModeFlag << 1, //0x00000008
1.610 + KImap4EmailDeleteEmailsWhenDisconnecting = KImap4EmailAutoSendFlag << 1, //0x00000010
1.611 + KImap4EmailAcknowledgeReceipts = KImap4EmailDeleteEmailsWhenDisconnecting << 1, //0x00000020
1.612 + KImap4EmailUpdatingSeenFlags = KImap4EmailAcknowledgeReceipts << 1, //0x00000040
1.613 + KImap4EmailIdleFlag = KImap4EmailUpdatingSeenFlags << 1, //0x00000080
1.614 + KImap4EmailExpungeFlag = KImap4EmailIdleFlag << 1,
1.615 + KImap4EmailUseSyncDownloadRules = KImap4EmailExpungeFlag << 1, //0x00000200
1.616 + KImap4EmailSettingsFolderSyncDisabled = KImap4EmailUseSyncDownloadRules << 1, //0x00000400
1.617 + KImap4EmailSettingsLastUsedFlag = KImap4EmailSettingsFolderSyncDisabled
1.618 + };
1.619 +
1.620 + TImImap4SettingsExtension* iExtension; // renamed iReceiptAddress
1.621 +
1.622 + TInt32 iInboxSyncLimit;
1.623 + TInt32 iMailboxSyncLimit;
1.624 +
1.625 + TText8 iPathSeparator;
1.626 + TFolderSyncType iSynchroniseStrategy;
1.627 + TFolderSubscribeType iSubscriptionStrategy;
1.628 + TUint32 iMaxEmailSize;
1.629 + TImap4GetMailOptions iGetMailOptions;
1.630 + };
1.631 +
1.632 +
1.633 +class TImImap4GetMailInfo
1.634 +/**
1.635 +Specifies options used when retrieving messages with IMAP.
1.636 +
1.637 +An TImImap4GetMailInfo is passed as a packaged parameter
1.638 +to CImap4ClientMtm::InvokeAsyncFunctionL() when a message
1.639 +getting command is issued.
1.640 +
1.641 +Options include the maximum message size, and what
1.642 +message parts are required.
1.643 +
1.644 +@see CImImap4GetMail
1.645 +@see TImap4Cmds
1.646 +
1.647 +@publishedAll
1.648 +@released
1.649 +*/
1.650 + {
1.651 +public:
1.652 + /** The maximum message size (bytes).
1.653 + Messages of greater size are not fetched. */
1.654 + TInt32 iMaxEmailSize;
1.655 + /** The required message parts. */
1.656 + TImap4GetMailOptions iGetMailBodyParts;
1.657 + /** The destination folder ID, specifying the
1.658 + target folder when messages are copied or moved. */
1.659 + TMsvId iDestinationFolder;
1.660 + };
1.661 +
1.662 +/**
1.663 +Specifies message criteria that are used as a filter when retrieving messages partially.
1.664 +
1.665 +Options include the maximum size for the whole message,
1.666 +the maximum size for the body of the message,
1.667 +the maximum size for the attachments with the message, and
1.668 +the message parts required.
1.669 +
1.670 +An TImImap4GetPartialMailInfo is passed as a packaged parameter
1.671 +to CImap4ClientMtm::InvokeAsyncFunctionL() when a message
1.672 +populate command is issued.
1.673 +
1.674 +@see
1.675 +CImImap4GetMail
1.676 +
1.677 +@publishedAll
1.678 +@released
1.679 +*/
1.680 +
1.681 +class TImImap4GetPartialMailInfo : public TImImap4GetMailInfo
1.682 + {
1.683 +public:
1.684 + /** The maximum size limit for the total message (bytes). */
1.685 + TInt32 iTotalSizeLimit;
1.686 + /** The maximum size limit for body of the message (bytes). */
1.687 + TInt32 iBodyTextSizeLimit;
1.688 + /** The maximum size limit for the attachments (bytes). */
1.689 + TInt32 iAttachmentSizeLimit;
1.690 + /** The required message parts. */
1.691 + TImImap4PartialMailOptions iPartialMailOptions;
1.692 + };
1.693 +
1.694 +inline CImImap4Settings::TImImap4SettingsExtension* CImImap4Settings::Extension() const
1.695 + {
1.696 + return iExtension;
1.697 + }
1.698 +
1.699 +inline void CImImap4Settings::CheckExtensionExistsL()
1.700 + {
1.701 + if (!iExtension)
1.702 + iExtension=new (ELeave) CImImap4Settings::TImImap4SettingsExtension;
1.703 + }
1.704 +inline CImImap4Settings::TImImap4SettingsExtension::TImImap4SettingsExtension()
1.705 +: iLoginName(NULL) ,iPassword(NULL) ,iFolderPath(NULL),iSearchString(NULL),iTlsSslDomain(NULL), iSyncRate(KImapDefaultInboxSyncRate), iImapIdleTimeout(KImapDefaultIdleTimeout), iFetchSizeBytes(KImapDefaultFetchSizeBytes),
1.706 + iPartialMailOptions(ENoSizeLimits),iBodyTextSizeLimit(KMaxTInt),iAttachmentSizeLimit(KMaxTInt)
1.707 + {
1.708 + }
1.709 +
1.710 +
1.711 +#endif // __IMAPSET_H__