--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/email/email/smtp/src/T_SmtpCreateReplyMessage.cpp Thu Jan 21 12:53:44 2010 +0000
@@ -0,0 +1,325 @@
+// Copyright (c) 2007-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"
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+// @file
+// [TestStep Name]
+// SmtpCreateReplyMessage
+// [Paramaters]
+// ServiceType : Specifies the service type(IMAP or POP) under which message exists.
+// FolderName : Destination local folder where message is to be created.
+// ImapAccountName : If service type is IMAP4, specify the IMAP account name that holds the
+// message.
+// ParentFolderName: IMAP4 folder name that holds the message.
+// PopAccountName : If the the sevice type is POP3, specify POP account name.
+// CommandName : SMTP client MTM command used to create the Reply message.
+// FolderName : Destination local folder in which message would be storted.
+// SubjectOfExistingMsg: Sbject line of the existing message to which reply message
+// would be creted.
+// SubjectOfReplyMsg: Specifies the subject line to be set for the reply message.
+// This is an optional parameter and if not specified the subject line
+// would take the default format(Re: <SubjectOfExistingMsg>).
+// Creates a reply message using the message that exists under remote service. Remote service
+// can be of type IMAP4 or POP3.
+// [APIs Used]
+//
+//
+
+
+
+// User includes
+#include "T_SmtpCreateReplyMessage.h"
+#include <t_utilscentralrepository.h>
+#include <t_utilsenumconverter.h>
+#include <t_utils.h>
+
+
+// Epoc includes
+#include <miutmsg.h>
+
+
+// Literals Used
+_LIT(KServiceType, "ServiceType");
+
+_LIT(KImapAccountName,"ImapAccountName");
+_LIT(KParentFolderName,"ParentFolderName");
+
+_LIT(KPopAccountName,"PopAccountName");
+
+_LIT(KCommandName,"CommandName");
+_LIT(KFolderName, "FolderName");
+_LIT(KSubjectOfExistingMsg,"SubjectOfExistingMsg");
+
+_LIT(KSubjectOfReplyMsg, "SubjectOfReplyMsg");
+
+const TInt KZero={0};
+/**
+ Function : CT_SmtpCreateReplyMessage
+ Description : Constructor
+ @param : aSharedDataSMTP Reference to CT_MsgSharedDataSmtp
+ @return : N/A
+*/
+CT_SmtpCreateReplyMessage::CT_SmtpCreateReplyMessage(CT_MsgSharedDataSmtp& aSharedDataSMTP)
+: CT_MsgAsyncStepSMTP(aSharedDataSMTP)
+, iOperation(NULL)
+ {
+ SetTestStepName(KSmtpCreateReplyMessage);
+ }
+
+
+/**
+ Function : NewL
+ Description : Creates an object of CT_SmtpCreateReplyMessage
+ @return : N/A
+*/
+CT_SmtpCreateReplyMessage* CT_SmtpCreateReplyMessage::NewL(CT_MsgSharedDataSmtp& aSharedDataSMTP)
+ {
+ CT_SmtpCreateReplyMessage* self = new(ELeave) CT_SmtpCreateReplyMessage(aSharedDataSMTP);
+ CleanupStack::PushL(self);
+ self->ConstructL();
+ CleanupStack::Pop(self);
+ return self;
+ }
+
+
+/**
+ Function : ~CT_SmtpCreateReplyMessage
+ Description : Destructor
+ @return : N/A
+*/
+CT_SmtpCreateReplyMessage::~CT_SmtpCreateReplyMessage()
+ {
+ delete iOperation;
+ iOperation = NULL;
+ }
+
+/**
+ Function : ProgressL
+ Description : Displays the status of the asynchronous operation
+ @return : N/A
+*/
+void CT_SmtpCreateReplyMessage::ProgressL(TBool /*bFinal*/)
+ {}
+
+
+/**
+ Function : CancelStep
+ Description : Cancels the asynchronous operation
+ @return : N/A
+*/
+void CT_SmtpCreateReplyMessage::CancelStep()
+ {
+ iOperation->Cancel();
+ }
+
+
+/**
+ Function : doTestStepL
+ Description : Creates a Reply message for an existing message. Existing message
+ may be under some remot folder under IMAP service or under POP service.
+ @return : TVerdict - Test step result
+*/
+TVerdict CT_SmtpCreateReplyMessage::doTestStepL()
+ {
+ INFO_PRINTF1(_L("TestStep: SmtpCreateReplyMessage"));
+ TMsvId entryToBesearched = KMsvNullIndexEntryId;
+ TPtrC serviceType;
+ if(!GetStringFromConfig( ConfigSection(), KServiceType, serviceType))
+ {
+ ERR_PRINTF1(_L("Service type for the message is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ TBuf<4> temp(serviceType);
+ temp.UpperCase(); // Makes case insensitive
+ // Perform the following if message has been downloaded using IMAP4 service
+ if(temp.CompareC(_L("IMAP")) == KZero)
+ {
+ // Read the IMAP account name from the ini file
+ TPtrC imapAccountName;
+ if(!GetStringFromConfig( ConfigSection(), KImapAccountName, imapAccountName))
+ {
+ ERR_PRINTF1(_L("ImapAccount Name is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ TPtrC parentFolderName;
+ if(!GetStringFromConfig( ConfigSection(), KParentFolderName, parentFolderName))
+ {
+ ERR_PRINTF1(_L("Parent Folder is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+
+ // retrieves the folder Id based on the remote service folder name read from the ini file
+ entryToBesearched = CT_MsgUtils::GetRemoteFolderIdByNameL(iSharedDataSMTP.iSession, imapAccountName, parentFolderName);
+ if( entryToBesearched == KErrNotFound)
+ {
+ ERR_PRINTF1(_L("Invalid Remote folder name specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ INFO_PRINTF2(_L("The parent folder Id is %d"),entryToBesearched );
+ }
+ }
+ }
+ }
+ // Perform the following if message has been downloaded using POP3 service
+ else if(temp.CompareC(_L("POP")) == KZero)
+ {
+ TPtrC popAccountName;
+ if(!GetStringFromConfig( ConfigSection(), KPopAccountName, popAccountName))
+ {
+ ERR_PRINTF1(_L("PopAccount Name is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ // Retrieves the Pop service Id for the given Pop account
+ entryToBesearched = CT_MsgUtilsCentralRepository::GetPopServiceIdL((TDes&)popAccountName);
+ INFO_PRINTF2(_L("Pop service id is %d"), entryToBesearched);
+
+ // Fails the test step if an invalid POP account is specified
+ if(entryToBesearched == KMsvNullIndexEntryId)
+ {
+ ERR_PRINTF1(_L("Invalid POP account name specified"));
+ SetTestStepResult(EFail);
+ }
+ }
+ }
+ else
+ {
+ ERR_PRINTF1(_L("Sevice Type is not specified: It should be IMAP or POP"));
+ SetTestStepResult(EFail);
+ }
+ }
+
+ if(TestStepResult() == EPass)
+ {
+ TPtrC commandName;
+ if(!GetStringFromConfig( ConfigSection(), KCommandName, commandName))
+ {
+ ERR_PRINTF1(_L("Command name is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ // Read the name of the target folder from the ini file
+ TPtrC folderName;
+ if(!GetStringFromConfig( ConfigSection(), KFolderName, folderName))
+ {
+ ERR_PRINTF1(_L("Folder name is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ TPtrC subjectOfExistingMsg;
+ if( !GetStringFromConfig(ConfigSection(), KSubjectOfExistingMsg, subjectOfExistingMsg))
+ {
+ ERR_PRINTF1(_L("The subject of the message is not specified"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ // Retrieves the message Id based on the message subject from the given remote service folder
+ TMsvId messageId;
+ messageId = CT_MsgUtils::SearchMessageBySubjectL(iSharedDataSMTP.iSession, entryToBesearched, subjectOfExistingMsg, ETrue);
+ if( messageId == KMsvNullIndexEntryId)
+ {
+ ERR_PRINTF1(_L("The given message is not found"));
+ SetTestStepResult(EFail);
+ }
+ else
+ {
+ TMsvId folderId;
+ folderId = CT_MsgUtilsEnumConverter::FindFolderIdByName(folderName);
+
+ // Interpret the SMTP client MTM command to be executed
+ TSmtpCmds commandId = CT_MsgUtilsEnumConverter::ConvertDesToTSmtpCmdsL((TDesC&) commandName);
+
+ CMsvEntrySelection* selection = new (ELeave) CMsvEntrySelection;
+ CleanupStack::PushL(selection);
+
+ selection->AppendL(folderId);
+ selection->AppendL(messageId);
+
+ TImCreateMessageOptions createMessageOptions;
+ createMessageOptions.iMsvPartList = KMsvMessagePartBody;
+ createMessageOptions.iMessageType = KUidMsgTypeSMTP;
+ createMessageOptions.iMsvEmailTypeList = 0;
+
+ TPckgBuf<TImCreateMessageOptions> paramPack(createMessageOptions);
+
+ CT_MsgActive& active=Active();
+ delete iOperation;
+ iOperation = NULL;
+ TRAPD(err2,iOperation = iSharedDataSMTP.iMtm->InvokeAsyncFunctionL(commandId,*selection,paramPack,active.iStatus));
+ active.Activate();
+ CActiveScheduler::Start();
+ SetHeaderPartL();
+
+ User::LeaveIfError(active.Result());
+ INFO_PRINTF2(_L("err2 : %d"), err2);
+ CleanupStack::PopAndDestroy(selection); // selection
+ }
+ }
+ }
+ }
+ }
+ return TestStepResult();
+ }
+
+
+/**
+ Function : SetHeaderPartL
+ Description : Sets the message header fields. If the field values are not provided
+ as input, it takes the default values.
+ @return : N/A
+*/
+void CT_SmtpCreateReplyMessage::SetHeaderPartL()
+ {
+ //Get the message ID from the CMsvOperation object
+ TMsvId temp;
+ TPckgC<TMsvId> paramPack(temp);
+ const TDesC8& progBuf = iOperation->ProgressL();
+ paramPack.Set(progBuf);
+ TMsvId newMessageId = paramPack();
+ if (newMessageId!=NULL)
+ {
+ CMsvEntry *entry = CMsvEntry::NewL(*(iSharedDataSMTP.iSession), newMessageId, TMsvSelectionOrdering(KMsvNoGrouping,EMsvSortByNone,ETrue));
+ CleanupStack::PushL(entry);
+ entry->SetEntryL(newMessageId); //
+ CMsvStore* store = entry->EditStoreL();
+ CleanupStack::PushL(store);
+
+ CImHeader* header = CImHeader::NewLC();
+ header->RestoreL(*store); // Retrieves the email message header part from the message store
+ TPtrC subjectOfReplyMsg;
+ if(GetStringFromConfig(ConfigSection(), KSubjectOfReplyMsg, subjectOfReplyMsg))
+ {
+ header->SetSubjectL(subjectOfReplyMsg);
+ }
+ header->StoreL(*store);
+ store->CommitL(); // Saves the modifications to message store
+ TMsvEntry indexEntry = entry->Entry();
+ indexEntry.iDescription.Set(header->Subject());
+ INFO_PRINTF2(_L("Subject field of Reply message : %S"), &(indexEntry.iDescription));
+ indexEntry.SetVisible(ETrue);
+ entry->ChangeL(indexEntry); // Modify the corresponding index entry permanently
+
+ CleanupStack::PopAndDestroy(3,entry); // header, store, entry
+ }
+ }