/// <summary>
/// Verify whether the specified folder was soft deleted.
/// </summary>
/// <param name="folderId">The specified folder ID.</param>
/// <returns>Return a Boolean value indicates whether the specified folder was soft deleted.</returns>
protected bool IsFolderSoftDeleted(ulong folderId)
{
bool folderDeleted = this.IsFolderDeleted(folderId);
bool folderSoftDeleted = false;
if (folderDeleted)
{
RopOpenFolderRequest openFolderRequest = new RopOpenFolderRequest
{
RopId = (byte)RopId.RopOpenFolder,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
OutputHandleIndex = Constants.CommonOutputHandleIndex,
OpenModeFlags = (byte)FolderOpenModeFlags.OpenSoftDeleted,
FolderId = folderId
};
RopOpenFolderResponse openFolderResponse = this.Adapter.OpenFolder(openFolderRequest, this.LogonHandle, ref this.responseHandles);
if (openFolderResponse.ReturnValue == 0)
{
folderSoftDeleted = true;
}
}
return(folderSoftDeleted);
}
/// <summary>
/// Open a specified message in specified folder.
/// </summary>
/// <param name="messageId">The specified message ID.</param>
/// <param name="folderId">The specified folder ID.</param>
/// <param name="openModeFlags">OpenModeFlags for RopOpenMessage.</param>
/// <returns>The response of RopOpenMessage ROP operation.</returns>
protected RopOpenMessageResponse OpenMessage(ulong messageId, ulong folderId, MessageOpenModeFlags openModeFlags)
{
RopOpenFolderRequest openFolderRequest = new RopOpenFolderRequest
{
RopId = (byte)RopId.RopOpenFolder,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
OutputHandleIndex = Constants.CommonOutputHandleIndex,
OpenModeFlags = (byte)FolderOpenModeFlags.None,
FolderId = folderId
};
RopOpenFolderResponse openFolderResponse = this.Adapter.OpenFolder(openFolderRequest, this.LogonHandle, ref this.responseHandles);
uint folderHandle = this.responseHandles[0][openFolderResponse.OutputHandleIndex];
RopOpenMessageRequest openMessageRequest = new RopOpenMessageRequest();
object ropResponse = null;
openMessageRequest.RopId = (byte)RopId.RopOpenMessage;
openMessageRequest.LogonId = Constants.CommonLogonId;
openMessageRequest.InputHandleIndex = Constants.CommonInputHandleIndex;
openMessageRequest.OutputHandleIndex = Constants.CommonOutputHandleIndex;
openMessageRequest.OpenModeFlags = (byte)openModeFlags;
openMessageRequest.FolderId = folderId;
openMessageRequest.MessageId = messageId;
openMessageRequest.CodePageId = 0x0fff;
this.Adapter.DoRopCall(openMessageRequest, folderHandle, ref ropResponse, ref this.responseHandles);
return((RopOpenMessageResponse)ropResponse);
}
/// <summary>
/// This ROP opens an existing folder in a mailbox.
/// </summary>
/// <param name="handle">The handle to operate</param>
/// <param name="openFolderResponse">The response of this ROP</param>
/// <param name="folderId">The identifier of the folder to be opened.</param>
/// <param name="needVerify">Whether need to verify the response</param>
/// <returns>The handle of the opened folder</returns>
private uint RopOpenFolder(uint handle, out RopOpenFolderResponse openFolderResponse, ulong folderId, bool needVerify)
{
this.rawDataValue = null;
this.responseValue = null;
this.responseSOHsValue = null;
RopOpenFolderRequest openFolderRequest = new RopOpenFolderRequest()
{
RopId = (byte)RopId.RopOpenFolder,
LogonId = LogonId,
InputHandleIndex = (byte)HandleIndex.FirstIndex,
OutputHandleIndex = (byte)HandleIndex.SecondIndex,
FolderId = folderId,
// Open an existing folder with None value for OpenModeFlags flag.
OpenModeFlags = (byte)FolderOpenModeFlags.None
};
this.responseSOHsValue = this.ProcessSingleRop(openFolderRequest, handle, ref this.responseValue, ref this.rawDataValue, RopResponseType.SuccessResponse);
openFolderResponse = (RopOpenFolderResponse)this.responseValue;
if (needVerify)
{
this.Site.Assert.AreEqual((uint)RopResponseType.SuccessResponse, openFolderResponse.ReturnValue, string.Format("RopOpenFolderResponse Failed! Error: 0x{0:X8}", openFolderResponse.ReturnValue));
}
return(this.responseSOHsValue[0][openFolderResponse.OutputHandleIndex]);
}
/// <summary>
/// Opens an existing folder.
/// </summary>
/// <param name="inputHandle">The input Server object for this operation is a Logon object or a Folder object that represents the object to be opened.</param>
/// <param name="folderId">The folder ID specifies the folder to be opened.</param>
/// <param name="folderHandle">A Folder object that represents the folder that was opened.</param>
/// <returns>The RopOpenFolder ROP response buffer.</returns>
protected RopOpenFolderResponse OpenFolder(uint inputHandle, ulong folderId, ref uint folderHandle)
{
RopOpenFolderRequest openFolderRequest = new RopOpenFolderRequest
{
RopId = (byte)RopId.RopOpenFolder,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
OutputHandleIndex = Constants.CommonOutputHandleIndex,
OpenModeFlags = (byte)FolderOpenModeFlags.None,
FolderId = folderId
};
RopOpenFolderResponse openFolderResponse = this.Adapter.OpenFolder(openFolderRequest, inputHandle, ref this.responseHandles);
folderHandle = this.responseHandles[0][openFolderResponse.OutputHandleIndex];
return(openFolderResponse);
}
/// <summary>
/// Opens an existing folder.
/// </summary>
/// <param name="ropOpenFolderRequest">RopOpenFolderRequest object.</param>
/// <param name="insideObjHandle">Server object handle in RopOpenFolderRequest.</param>
/// <param name="responseSOHTable">Server objects handles in RopOpenFolderResponse.</param>
/// <returns>RopOpenFolderResponse object.</returns>
public RopOpenFolderResponse OpenFolder(RopOpenFolderRequest ropOpenFolderRequest, uint insideObjHandle, ref List <List <uint> > responseSOHTable)
{
object temp = new object();
ropOpenFolderRequest.RopId = (byte)RopId.RopOpenFolder;
ropOpenFolderRequest.LogonId = Constants.CommonLogonId;
ropOpenFolderRequest.InputHandleIndex = Constants.CommonInputHandleIndex;
ropOpenFolderRequest.OutputHandleIndex = Constants.CommonOutputHandleIndex;
this.ExcuteRopCall((ISerializable)ropOpenFolderRequest, insideObjHandle, ref temp, ref responseSOHTable, ref this.rawData);
RopOpenFolderResponse ropOpenFolderResponse = (RopOpenFolderResponse)temp;
#region Capture Code
// The ReturnValue equal to 0x00000000 indicate ROP operation success
if (0x00000000 == ropOpenFolderResponse.ReturnValue)
{
this.VerifyRopOpenFolder(ropOpenFolderResponse);
}
#endregion
return(ropOpenFolderResponse);
}
/// <summary>
/// Initialize a generic folder under inbox as a root folder for test.
/// </summary>
protected void GenericFolderInitialization()
{
RopLogonResponse logonResponse = this.Logon(LogonFlags.Private, out this.logonHandle);
#region Open the inbox folder.
RopOpenFolderRequest openFolderRequest = new RopOpenFolderRequest
{
RopId = (byte)RopId.RopOpenFolder,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
OutputHandleIndex = Constants.CommonOutputHandleIndex,
FolderId = logonResponse.FolderIds[Constants.InboxIndex],
OpenModeFlags = (byte)FolderOpenModeFlags.OpenSoftDeleted
};
// Use the logon object as input handle here.
RopOpenFolderResponse openFolderResponse = this.Adapter.OpenFolder(openFolderRequest, this.LogonHandle, ref this.responseHandles);
this.inboxFolderHandle = this.responseHandles[0][openFolderResponse.OutputHandleIndex];
#endregion
#region Create a generic folder for test.
RopCreateFolderRequest createFolderRequest = new RopCreateFolderRequest();
RopCreateFolderResponse createFolderResponse = new RopCreateFolderResponse();
createFolderRequest.RopId = (byte)RopId.RopCreateFolder;
createFolderRequest.LogonId = Constants.CommonLogonId;
createFolderRequest.InputHandleIndex = Constants.CommonInputHandleIndex;
createFolderRequest.OutputHandleIndex = Constants.CommonOutputHandleIndex;
createFolderRequest.FolderType = 0x01;
createFolderRequest.UseUnicodeStrings = 0x0;
createFolderRequest.OpenExisting = 0x01;
createFolderRequest.Reserved = 0x0;
createFolderRequest.DisplayName = Encoding.ASCII.GetBytes(this.RootFolder);
createFolderRequest.Comment = Encoding.ASCII.GetBytes(this.RootFolder);
createFolderResponse = this.Adapter.CreateFolder(createFolderRequest, this.inboxFolderHandle, ref this.responseHandles);
Site.Assert.AreEqual <uint>(0, createFolderResponse.ReturnValue, "Creating Folder should succeed.");
this.rootFolderHandle = this.responseHandles[0][createFolderResponse.OutputHandleIndex];
this.rootFolderId = createFolderResponse.FolderId;
this.isRootFolderCreated = true;
#endregion
}
