// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#include "IMAPSET.H"

#include <nifvar.h>				// For KLinkLayerOpen

GLREF_C TPtrC8 LimitStringSize(const TPtrC8& aString, TInt aMaxSize);

EXPORT_C CImImap4Settings::CImImap4Settings()

/** 

Allocates and creates a new CImImap4Settings object initialised to

default values.

*/

	{

	Reset();

	} 

EXPORT_C CImImap4Settings::~CImImap4Settings()

/**

Destructor.

*/

	{

	Reset();

	delete iExtension;

	iExtension = NULL;

	} 

EXPORT_C void CImImap4Settings::Reset()

/**

Resets the settings to their default values.

*/

	{

	CImBaseEmailSettings::Reset();

	SetPort(KIMAPDefaultPortNumber);

	SetImapIdle(ETrue);

	iInboxSyncLimit=KImImapSynchroniseAll;

	iMailboxSyncLimit=KImImapSynchroniseAll;

	iMaxEmailSize = KMaxTInt;

	iPathSeparator='\0';

	iSynchroniseStrategy=EUseRemote;

	iSubscriptionStrategy=EUpdateNeither;

	if (Extension())

		{

		delete Extension()->iLoginName;

		Extension()->iLoginName=NULL;

		delete Extension()->iPassword;

		Extension()->iPassword = NULL;

		delete Extension()->iFolderPath;

		Extension()->iFolderPath = NULL;

		delete Extension()->iTlsSslDomain;

		Extension()->iTlsSslDomain = NULL;

		delete Extension()->iSearchString;

		Extension()->iSearchString = NULL;

		Extension()->iSyncRate = KImapDefaultInboxSyncRate;

		Extension()->iImapIdleTimeout = KImapDefaultIdleTimeout;

		Extension()->iFetchSizeBytes = KImapDefaultFetchSizeBytes;

		Extension()->iPartialMailOptions = ENoSizeLimits;

		Extension()->iBodyTextSizeLimit = KMaxTInt;

		Extension()->iAttachmentSizeLimit = KMaxTInt;

		}

	}

EXPORT_C const TPtrC8 CImImap4Settings::LoginName() const

/**

Retrieves the configured login user name (mailbox) of the IMAP4 service.

@see

SetLoginNameL()

@return 

The user name.

*/

	{

	if (Extension() && Extension()->iLoginName)

		return TPtrC8(*(Extension()->iLoginName));

	return TPtrC8();

	}

EXPORT_C const TPtrC8 CImImap4Settings::Password() const

/**

Retrieves the configured login password that will be sent during

authentication with the IMAP4 server.

@see

SetPasswordL()

@return 

The password.

*/

	{

	if (Extension() && Extension()->iPassword)

		return TPtrC8(*(Extension()->iPassword));

	return TPtrC8();

	}

EXPORT_C const TPtrC8 CImImap4Settings::FolderPath() const

/**

Retrieves the configured path of the IMAP4 mailbox on the server if the user's

primary mailbox is not in the Inbox folder.

Most of the time this setting will not have to be configured, however this may need

to be altered by the user for use with some IMAP4 servers. Refer to RFC 3501

Section 5.1 Mailbox Naming for more information.

The default setting is empty. 

@return

The folder path.

*/

	{

	if (Extension() && Extension()->iFolderPath)

		return TPtrC8(*(Extension()->iFolderPath));

	return TPtrC8();

	}

/**

Gets the search string used to filter which messages are synchronised.

For details, see SetSearchStringL().

@return Synchronisation filter string

*/

EXPORT_C const TPtrC8 CImImap4Settings::SearchString() const

	{

	if (Extension() && Extension()->iSearchString)

		return TPtrC8(*(Extension()->iSearchString));

	return TPtrC8();

	}

/**

Sets a search string for the service.

This setting allows a filter to be specified that prevents certain e-mail

messages from being synchronised onto the device when a client requests a

synchronisation. An IMAP Search command is issued to the server to provide a

list of messages to be synchronised.

Note that when a synchronisation command is given with a search string set:

- Mailbox synchronisation limits are ignored.

- Existing messages that do not match the search criteria, and that have not had their body fetched,

  are deleted locally.

- If the remote server does not support the filter, or the filter is malformed,

  the synchronisation command will return an error.

To remove a filter, set the search string to KNullDesC.

A complete overview of the syntax of search strings is given in section 6.4.4

(SEARCH Command) of RFC 3501. Some valid example search strings are:

@code 

FLAGGED SINCE 1-Feb-1994 NOT FROM "Smith"

BODY "some text in the body"

@endcode

@param aSearchString Synchronisation filter string

*/

EXPORT_C void CImImap4Settings::SetSearchStringL(const TDesC8& aSearchString)

	{

	CheckExtensionExistsL();

	HBufC8* newSearchString = aSearchString.AllocL();

	delete Extension()->iSearchString;

	Extension()->iSearchString = newSearchString;

	}

EXPORT_C TText8 CImImap4Settings::PathSeparator() const

/**

Retrieves the character configured to separate hierarchical mailbox names on

the IMAP4 server. Refer to RFC 3501 section 5.1.1 for more information.

The default setting an empty null-terminated string.

@return

The path separator character.

*/

	{

	return iPathSeparator;

	}

EXPORT_C TFolderSyncType CImImap4Settings::Synchronise() const

/**

Retrieves the method for synchronising folder information with the server. 

The default setting is EUseRemote.

@see

TFolderSyncType

@return

The folder synchronisation method.

*/

	{

	return iSynchroniseStrategy;

	}

EXPORT_C TFolderSubscribeType CImImap4Settings::Subscribe() const

/**

Retrieves the configured method for synchronising IMAP4 subscription information

with a server.

The default setting is EUpdateNeither.

@see

TFolderSubscribeType

@return

The subscription method.

*/

	{

	return iSubscriptionStrategy;

	}

EXPORT_C void CImImap4Settings::SetLoginNameL(const TDesC8& aLoginName)

/**

Configures the login user name (mailbox) for the IMAP4 service.

@param aLoginName

The login user name. A copy of aLoginName is made so if you

want to change the user name you must call this method again for the

changes to take effect.

*/	{

	CheckExtensionExistsL();

	HBufC8* newLoginName = aLoginName.AllocL();

	delete Extension()->iLoginName;

	Extension()->iLoginName = newLoginName;

	}

EXPORT_C void CImImap4Settings::SetPasswordL(const TDesC8& aPassword)

/**

Configures the login password for the IMAP4 service.

@param aPassword

The login password. A copy of aPassword is made so if you

want to change the user name you must call this method again for the

changes to take effect.

*/

	{

	CheckExtensionExistsL();

	HBufC8* newPassword = aPassword.AllocL();

	delete Extension()->iPassword;

	Extension()->iPassword = newPassword;

	}

EXPORT_C void CImImap4Settings::SetFolderPathL(const TDesC8& aFolderPath)

/**

Specifies the path to the IMAP4 mailbox on the server if the user's primary

mailbox is not in the Inbox folder.

Most of the time this setting will not have to be configured, however this may need

to be altered by the user for use with some IMAP4 servers. Refer to RFC 3501

Section 5.1 Mailbox Naming for more information.

The default setting is empty. 

@param aFolderPath

The folder path.

*/

	{

	CheckExtensionExistsL();

	HBufC8* newFolderPath = aFolderPath.AllocL();

	delete Extension()->iFolderPath;

	Extension()->iFolderPath = newFolderPath;

	}

EXPORT_C void CImImap4Settings::SetPathSeparator(const TText8 aPathSeparator)

/**

Specifies the character used to separate hierarchical mailbox names on

the IMAP4 server. Refer to RFC 3501 section 5.1.1 for more information.

The default setting an empty null-terminated string.

@param aPathSeparator

The path separator character.

*/

	{

	iPathSeparator = aPathSeparator;

	}

EXPORT_C void CImImap4Settings::SetSynchronise(const TFolderSyncType aType)

/** 

Sets the method for synchronising folder information with the server.

The default setting is EUseRemote.

@see

TFolderSyncType

@param aType

The folder synchronisation method.

*/

	{

	iSynchroniseStrategy = aType;

	}

EXPORT_C void CImImap4Settings::SetSubscribe(const TFolderSubscribeType aType)

/**

Sets the method for synchronising IMAP4 subscription information with a server.

The default setting is EUpdateNeither.

@see

TFolderSubscribeType

@param aType

The subscription method.

*/

	{

	iSubscriptionStrategy = aType;

	}

EXPORT_C TBool CImImap4Settings::DisconnectedUserMode() const

/**

Checks if disconnected user mode is configured.

If disconnected user mode is enabled by calling SetDisconnectedUserMode(), 

then the IMAP4 client MTM (CImap4ClientMtm) will accept message operations, 

such as deleting messages from a server, while the user is offline.

The operations are stored and executed when the user connects again.

@see

CImap4ClientMtm

@return 

ETrue if disconnected user mode is enabled.

*/

	{

	return iFlags & KImap4EmailDisconnectedModeFlag;

	}

EXPORT_C void CImImap4Settings::SetDisconnectedUserMode(TBool aFlag)

/** 

Enables the IMAP4 client MTM (CImap4ClientMtm) to accept message operations

while disconnected.

If disconnected user mode is enabled the IMAP4 client MTM will accept message

operations such as deleting messages from a server, while the user is offline.

The operations are stored and executed when the user connects again.

@see

CImap4ClientMtm

@param aFlag

Specify ETrue to enable disconnected user mode.

Specify EFalse to disable disconnected user mode.

*/

	{

	iFlags = (iFlags & ~KImap4EmailDisconnectedModeFlag) | (aFlag ? KImap4EmailDisconnectedModeFlag : KImap4EmailSettingsClearFlag);

	}

EXPORT_C TBool CImImap4Settings::AutoSendOnConnect() const

/**

@return 

ETrue if configured to send emails after the connection is established, but before

authentication with the IMAP4 server.

*/

	{

	return iFlags & KImap4EmailAutoSendFlag;

	}

EXPORT_C void CImImap4Settings::SetAutoSendOnConnect(TBool aFlag)

/** 

Configures the IMAP4 service to send queued emails associated with the same internet

access point to be sent first before logging onto the IMAP4 server.

The internet access point for each email service (POP3, IMAP4, SMTP) is configured

using CImIAPPreferences.

@see

CImIAPPreferences

@param aFlag 

Specify ETrue to send emails after the connection is established, but before

authentication with the IMAP4 service.

Specify EFalse to disable this functionality.

*/

	{

	iFlags = (iFlags & ~KImap4EmailAutoSendFlag) | (aFlag ? KImap4EmailAutoSendFlag : KImap4EmailSettingsClearFlag);

	}

EXPORT_C TUint CImImap4Settings::MaxEmailSize() const

/**

Returns the maximum message size in bytes to be downloaded.

This value is set by a calling SetMaxEmailSize(). The default setting is

KMaxInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used

by client applications to store a user preference, and used when issuing get

commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a 

TImImap4GetMailInfo parameter, which has a iMaxEmailSize setting.

@see TImImap4GetMailInfo

@see CImImap4GetMail

@see CImap4ClientMtm

@return The maximum message size in bytes.

*/

	{

	return iMaxEmailSize;

	}

EXPORT_C void CImImap4Settings::SetMaxEmailSize(const TUint aMaxEmailSize)

/** 

Sets the maximum message size in bytes to be downloaded.

The default setting is KMaxInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used

by client applications to store a user preference, and used when issuing get

commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a 

TImImap4GetMailInfo parameter, which has a iMaxEmailSize setting.

@see TImImap4GetMailInfo

@see CImImap4GetMail

@see CImap4ClientMtm

@return

The maximum message size in bytes.

*/

	{

	iMaxEmailSize = aMaxEmailSize;

	}

EXPORT_C TBool CImImap4Settings::DeleteEmailsWhenDisconnecting() const

/** 

Checks whether the caller has enabled messages marked to be deleted while offline

to be expunged from the server when disconnecting from the next online session.

Otherwise they are marked for delete and expunged during the initial

synchronisation.

To enable this functionality, call SetDeleteEmailsWhenDisconnecting().

@see

CImap4ClientMtm

@return

ETrue if emails are to be deleted during the disconnection phase.

*/

	{

	return iFlags & KImap4EmailDeleteEmailsWhenDisconnecting;

	}

EXPORT_C void CImImap4Settings::SetDeleteEmailsWhenDisconnecting(TBool aFlag)

/** 

If enabled, messages marked as deleted while offline will be deleted when

logging off from the next IMAP4 session. If disabled, messages are deleted

when the client synchronises with the server after a connection.

Enabling this functionality has the advantage of speeding up synchronisation

at the expense of disconnection speed.

@see

CImap4ClientMtm

@param aFlag

Specify ETrue to enable.

*/

	{

	iFlags = (iFlags & ~KImap4EmailDeleteEmailsWhenDisconnecting) | (aFlag ? KImap4EmailDeleteEmailsWhenDisconnecting : KImap4EmailSettingsClearFlag);

	}

EXPORT_C TBool CImImap4Settings::AcknowledgeReceipts() const

/** 

Checks whether the caller has enabled this setting by calling 

SetAcknowledgeReceipts().

This flag is a convenience setting for Messaging client applications that may 

wish to store whether or not to send a receipt email message to the sender when the

email has been received. The Messaging subsystem does not use this setting, 

and has to be explicitly commanded by the Messaging client application to

send a receipt notification. Messaging applications can use CImHeader to check

if a message has a return receipt address. Receipt notification messages can 

be created using CImEmailOperation, and sent using the SMTP client MTM.

@see CImHeader

@see CImEmailOperation

@see CSmtpClientMtm

@return