epoc32/include/smtcmtm.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files

// 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// SMTCPMTM.H
// Client MTM for the SMTP protocol
// 
//

#if !defined (__SMTCMTM_H__)
#define __SMTCMTM_H__

#if !defined (__E32BASE_H__)
#include <e32base.h>		// CActive, TFileName)
#endif

#if !defined(__BADESCA_H__)
#include <badesca.h>
#endif

#if !defined (__MSVAPI_H__)
#include <msvapi.h>
#endif

#if !defined (__MTCLBASE_H__)
#include <mtclbase.h>
#endif

#if !defined (__MIUTHDR_H__)
#include <miuthdr.h>
#endif

#if !defined (__MIUTPARS_H__)
#include <miutpars.h>		//TImMessageField
#endif

#if !defined (__MIUTMSG_H__)
#include <miutmsg.h>		//CImEmailMessage
#endif

#if !defined (__SMTPSET_H__)
#include <smtpset.h>
#endif

#if !defined (__SMTPCMDS_H__)
#include <smtpcmds.h>
#endif

class CMsvEntry;
class CMtmDllRegistry;
class CRichText;
class TMsvEntry;
class CRegisteredMtmDll;
class CImSmtpSettings;
class CMsvSession;
class CImAttachmentWaiter;

///////  Smtp Client MTM  /////////////////////////////////////////////////////////////////////////////
class CSmtpClientMtm : public CBaseMtm
/** SMTP client MTM interface.

Most of the functions in this class are implementations of the virtual functions 
defined by the base class CBaseMtm. 
@publishedAll
@released
*/
	{
public:
	IMPORT_C static CSmtpClientMtm* NewL(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);
	~CSmtpClientMtm();

	void SaveMessageL();
	void LoadMessageL();

	IMPORT_C void StoreSettingsL();
	IMPORT_C void RestoreSettingsL();

	CMsvOperation* ReplyL  (TMsvId aReplyEntryId, TMsvPartList aPartlist, TRequestStatus& aCompletionStatus);
	CMsvOperation* ForwardL(TMsvId aForwardEntryId, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);

	TMsvPartList ValidateMessage(TMsvPartList aPartList);
	TMsvPartList Find(const TDesC& aTextToFind, TMsvPartList aPartList);

	// addresssee list (used by objects with no MTM knowledge)
	void AddAddresseeL(const TDesC& aRealAddress);
	void AddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias);
	void AddAddresseeL(TMsvRecipientType aType, const TDesC& aRealAddress);
	void AddAddresseeL(TMsvRecipientType aType, const TDesC& aRealAddress, const TDesC& aAlias);
	void RemoveAddressee(TInt aIndex);

	IMPORT_C void SetSettingsL(const CImSmtpSettings& aSettings);
	IMPORT_C const CImSmtpSettings& Settings() const; 
	IMPORT_C void SetSubjectL(const TDesC& aSubject);
	IMPORT_C const TPtrC SubjectL() const;

	// --- RTTI functions ---
	TInt QueryCapability(TUid aCapability, TInt& aResponse);
	void InvokeSyncFunctionL(TInt aFunctionId,const CMsvEntrySelection& aSelection, TDes8& aParameter);
	CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId,const CMsvEntrySelection& aSelection, TDes8& aParameter, TRequestStatus& aCompletionStatus);

	// Attachment functions to support the SendAs API
	IMPORT_C virtual void AddAttachmentL(const TDesC& aFilePath, const TDesC8& aMimeType, TUint aCharset, TRequestStatus& aStatus);
	IMPORT_C virtual void AddAttachmentL(RFile& aFile, const TDesC8& aMimeType, TUint aCharset, TRequestStatus& aStatus);
	IMPORT_C virtual void AddLinkedAttachmentL(const TDesC& aFilePath, const TDesC8& aMimeType, TUint aCharset, TRequestStatus& aStatus);
	IMPORT_C virtual void AddEntryAsAttachmentL(TMsvId aAttachmentId, TRequestStatus& aStatus);
	IMPORT_C virtual void CreateAttachmentL(const TDesC& aFileName, RFile& aAttachmentFile, const TDesC8& aMimeType, TUint aCharset, TRequestStatus& aStatus);
	IMPORT_C virtual void CreateMessageL(TMsvId aServiceId);

	IMPORT_C virtual TMsvId DefaultServiceL() const;
	IMPORT_C virtual void RemoveDefaultServiceL();
	IMPORT_C virtual void ChangeDefaultServiceL(const TMsvId& aService);
	IMPORT_C void CancelAttachmentOperation();

protected:
	CSmtpClientMtm(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);
	void ConstructL();
	
	void ContextEntrySwitched(); // called after the context of this instance has been changed to another entry
private:
	TBool ValidateAddress(const TPtrC& anAddress);
	void ResetData();

	void RestoreEmailMessageL();
	void StoreEmailMessageL();
	void SetAddresseeListL();
	void GetBodyTextL(CImEmailMessage& aMessage, TMsvId aMsvId);
	TInt32 GetAttachmentSizeL(CImEmailMessage& aMessage, TMsvId aMsvId);
	TMsvPartList DoFindL(const TDesC& aTextToFind, TMsvPartList aPartList);

private:
	CMsvOperationActiveSchedulerWait* iWait;
	CImSmtpSettings* iImSmtpSettings;
	CImHeader* iHeader;
	HBufC* iSubject;

	TImMessageField iTImMessageField;
	HBufC* iEmailAddressFormatString;	// defines format of email address used by "Send as" API eg _LIT("/"%S/" <%S>")
	CMsvEntrySelection* iEntrySelection;
	CImEmailOperation*	iImEmailOperation;
	CImAttachmentWaiter* iAttachmentWaiter;
	CImEmailMessage* iEmailMessage;
	};


#endif // __SMTCMTM_H__