/// <summary>
/// Deletes one or more messages from a folder.
/// </summary>
/// <param name="ropDeleteMessagesRequest">RopDeleteMessagesRequest object.</param>
/// <param name="insideObjHandle">Server object handle in RopDeleteMessages.</param>
/// <param name="responseSOHTable">Server objects handles in RopDeleteMessagesResponse.</param>
/// <returns>RopDeleteMessagesResponse object.</returns>
public RopDeleteMessagesResponse DeleteMessages(RopDeleteMessagesRequest ropDeleteMessagesRequest, uint insideObjHandle, ref List <List <uint> > responseSOHTable)
{
object temp = new object();
this.ExcuteRopCall((ISerializable)ropDeleteMessagesRequest, insideObjHandle, ref temp, ref responseSOHTable, ref this.rawData);
RopDeleteMessagesResponse ropDeleteMessagesResponse = (RopDeleteMessagesResponse)temp;
#region Capture Code
// The ReturnValue equal to 0x00000000 indicate ROP operation success
if (0x00000000 == ropDeleteMessagesResponse.ReturnValue)
{
this.VerifyRopDeleteMessages(ropDeleteMessagesResponse);
}
#endregion
return(ropDeleteMessagesResponse);
}
/// <summary>
/// Verify the response of RopDeleteMessages ROP operation.
/// </summary>
/// <param name="deleteMessagesResponse">The response of RopDeleteMessages operation</param>
private void VerifyRopDeleteMessages(RopDeleteMessagesResponse deleteMessagesResponse)
{
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R280");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R280
Site.CaptureRequirementIfAreEqual<uint>(
Constants.SuccessCode,
deleteMessagesResponse.ReturnValue,
280,
@"[In RopDeleteMessages ROP Response Buffer] ReturnValue (4 bytes): The server returns 0x00000000 to indicate success.");
}
public void MSOXCFOLD_S05_TC02_MessageDeletePartialCompleteValidation()
{
this.CheckWhetherSupportTransport();
this.Adapter.DoConnect(ConnectionType.PrivateMailboxServer);
uint logonHandle = 0;
uint pidTagMemberRights = 0;
this.GenericFolderInitialization();
#region Step 1. Add permission entry for the user configured by "CommonUser" on the inbox and the root folder.
uint inboxHandle = 0;
this.OpenFolder(this.LogonHandle, this.DefaultFolderIds[this.inboxIndex], ref inboxHandle);
// Add folder visible permission for the inbox.
pidTagMemberRights = (uint)PidTagMemberRightsEnum.FolderVisible | (uint)PidTagMemberRightsEnum.ReadAny;
this.AddPermission(this.commonUserEssdn, pidTagMemberRights, inboxHandle);
// Add folder visible permission for the root folder.
pidTagMemberRights = (uint)PidTagMemberRightsEnum.FolderVisible | (uint)PidTagMemberRightsEnum.ReadAny | (uint)PidTagMemberRightsEnum.EditOwned | (uint)PidTagMemberRightsEnum.Create | (uint)PidTagMemberRightsEnum.CreateSubFolder | (uint)PidTagMemberRightsEnum.DeleteOwned;
this.AddPermission(this.commonUserEssdn, pidTagMemberRights, this.RootFolderHandle);
#endregion
#region Step 2. Create message and subfolder in the root folder.
ulong messageId = 0;
uint messageHandle = 0;
this.CreateSaveMessage(this.RootFolderHandle, this.RootFolderId, ref messageId, ref messageHandle);
uint subfolderHandle = 0;
ulong subfolderId = 0;
this.CreateFolder(this.RootFolderHandle, Constants.Subfolder1, ref subfolderId, ref subfolderHandle);
#endregion
#region Step 3. Logon the user configured by "CommonUser".
this.Adapter.DoDisconnect();
this.Adapter.DoConnect(this.sutServer, ConnectionType.PrivateMailboxServer, this.commonUserEssdn, this.domain, this.commonUser, this.commonUserPassword);
this.Logon(LogonFlags.Private, out logonHandle, (uint)OpenFlags.UsePerMDBReplipMapping);
#endregion
#region Step 4. The "CommonUser" opens the root folder.
this.OpenFolder(logonHandle, this.DefaultFolderIds[this.inboxIndex], ref inboxHandle);
ulong rootFolderId = this.GetSubfolderIDByName(this.DefaultFolderIds[this.inboxIndex], logonHandle, this.RootFolder);
uint rootFolderHandle = 0;
RopOpenFolderResponse openFolderResponse = this.OpenFolder(logonHandle, rootFolderId, ref rootFolderHandle);
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R46202");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R46202
Site.CaptureRequirementIfAreEqual<uint>(
Constants.SuccessCode,
openFolderResponse.ReturnValue,
46202,
@"[In Processing a RopOpenFolder ROP Request] If the folder with the specified ID actually exists and the client has sufficient access rights to view the folder, the RopOpenFolder ROP performs successfully.");
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R394");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R394.
// MS-OXCFOLD_R462 was verified, MS-OXCFOLD_R462 can be verified directly.
Site.CaptureRequirement(
394,
@"[In Opening a Folder] The client MUST have sufficient access rights to the folder for this operation to succeed.");
ulong commonUserMessageId = 0;
uint commonUserMessageHandle = 0;
this.CreateSaveMessage(rootFolderHandle, rootFolderId, ref commonUserMessageId, ref commonUserMessageHandle);
uint commonUserSubfolderHandle = 0;
ulong commonUserSubfolderId = 0;
this.CreateFolder(rootFolderHandle, Constants.Subfolder2, ref commonUserSubfolderId, ref commonUserSubfolderHandle);
#endregion
#region Step 5. The client calls RopDeleteMessages to delete the message created in step 2.
ulong[] messageIds = new ulong[] { messageId, commonUserMessageId };
RopDeleteMessagesRequest deleteMessagesRequest = new RopDeleteMessagesRequest();
RopDeleteMessagesResponse deleteMessagesResponse = new RopDeleteMessagesResponse();
deleteMessagesRequest.RopId = (byte)RopId.RopDeleteMessages;
deleteMessagesRequest.LogonId = Constants.CommonLogonId;
deleteMessagesRequest.InputHandleIndex = Constants.CommonInputHandleIndex;
deleteMessagesRequest.WantAsynchronous = 0x00;
// The server does not generate a non-read receipt for the deleted messages.
deleteMessagesRequest.NotifyNonRead = 0x00;
deleteMessagesRequest.MessageIdCount = (ushort)messageIds.Length;
deleteMessagesRequest.MessageIds = messageIds;
deleteMessagesResponse = this.Adapter.DeleteMessages(deleteMessagesRequest, rootFolderHandle, ref this.responseHandles);
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R991");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R991
Site.CaptureRequirementIfAreNotEqual<byte>(
0,
deleteMessagesResponse.PartialCompletion,
991,
@"[In RopDeleteMessages ROP Response Buffer] PartialCompletion (1 byte): If the ROP [RopDeleteMessages] fails for a subset of targets, the value of this field is nonzero (TRUE).");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R1147");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R1147
Site.CaptureRequirementIfAreNotEqual<uint>(
0,
deleteMessagesResponse.PartialCompletion,
1147,
@"[In Processing a RopDeleteMessages ROP Request] If the server fails to delete any messages, it sets the PartialCompletion field of the RopDeleteMessages ROP response buffer to nonzero (TRUE), as specified in section 2.2.1.11.2.");
#endregion
#region Step 6. The client calls RopHardDeleteMessages to delete the message created in step 2.
RopHardDeleteMessagesRequest hardDeleteMessagesRequest = new RopHardDeleteMessagesRequest
{
RopId = 0x91,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
WantAsynchronous = 0x00,
NotifyNonRead = 0x00,
MessageIdCount = (ushort)messageIds.Length,
MessageIds = messageIds
};
RopHardDeleteMessagesResponse hardDeleteMessagesResponse = this.Adapter.HardDeleteMessages(hardDeleteMessagesRequest, rootFolderHandle, ref this.responseHandles);
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R997");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R997.
Site.CaptureRequirementIfAreNotEqual<byte>(
0,
hardDeleteMessagesResponse.PartialCompletion,
997,
@"[In RopHardDeleteMessages ROP Response Buffer] If the ROP [RopHardDeleteMessages] fails for a subset of targets, the value of this field is nonzero (TRUE).");
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R115602");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R115602
Site.CaptureRequirementIfAreNotEqual<byte>(
0,
hardDeleteMessagesResponse.PartialCompletion,
115602,
@"[In Processing a RopHardDeleteMessages ROP Request] In the server behavior, if the server fails to delete any messages, it sets the PartialCompletion field of the RopDeleteMessages ROP response buffer to nonzero (TRUE), as specified in section 2.2.1.11.2.");
#endregion
#region Step 7. The client calls RopHardDeleteMessagesAndSubfolders to delete the message created in step 2.
RopHardDeleteMessagesAndSubfoldersRequest hardDeleteMessagesAndSubfoldersRequest = new RopHardDeleteMessagesAndSubfoldersRequest
{
RopId = (byte)RopId.RopHardDeleteMessagesAndSubfolders,
LogonId = Constants.CommonLogonId,
InputHandleIndex = Constants.CommonInputHandleIndex,
WantAsynchronous = 0x00,
WantDeleteAssociated = 0xFF
};
RopHardDeleteMessagesAndSubfoldersResponse hardDeleteMessagesAndSubfoldersResponse = this.Adapter.HardDeleteMessagesAndSubfolders(hardDeleteMessagesAndSubfoldersRequest, rootFolderHandle, ref this.responseHandles);
if (Common.IsRequirementEnabled(2721, this.Site))
{
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R2721");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R2721
Site.CaptureRequirementIfAreNotEqual<byte>(
0,
hardDeleteMessagesAndSubfoldersResponse.PartialCompletion,
2721,
@"[In RopHardDeleteMessagesAndSubfolders ROP Response Buffer] PartialCompletion (1 byte): If the ROP [RopHardDeleteMessagesAndSubfolders] fails for a subset of targets, the value of this field is nonzero (TRUE).");
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R113803");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R113803.
Site.CaptureRequirement(
113803,
@"[In Processing a RopHardDeleteMessagesAndSubfolders ROP Request] In the server behavior, if the server fails to delete any message or subfolder, it sets the PartialCompletion field of the RopHardDeleteMessagesAndSubfolders ROP response buffer to nonzero (TRUE), as specified in section 2.2.1.10.2.");
}
#endregion
#region Step 8. The client calls RopMoveCopyMessages to move the message from the root folder to the inbox.
List<uint> handleList = new List<uint>
{
rootFolderHandle, inboxHandle
};
RopMoveCopyMessagesRequest moveCopyMessagesRequest = new RopMoveCopyMessagesRequest
{
RopId = (byte)RopId.RopMoveCopyMessages,
LogonId = Constants.CommonLogonId,
SourceHandleIndex = 0x00,
DestHandleIndex = 0x01,
MessageIdCount = (ushort)messageIds.Length,
MessageIds = messageIds,
WantAsynchronous = 0x00,
WantCopy = 0xFF
};
// WantCopy is nonzero (TRUE) indicates this is a copy operation.
RopMoveCopyMessagesResponse moveCopyMessagesResponse = this.Adapter.MoveCopyMessages(moveCopyMessagesRequest, handleList, ref this.responseHandles);
if (Common.IsRequirementEnabled(586, this.Site))
{
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R10163");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R10163.
Site.CaptureRequirementIfAreNotEqual<byte>(
0,
moveCopyMessagesResponse.PartialCompletion,
10163,
@"[In RopMoveCopyMessages ROP Response Buffer] PartialCompletion (1 byte): If the ROP fails for a subset of targets, the value of this field is nonzero (TRUE).");
// Add the debug information.
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCFOLD_R586");
// Verify MS-OXCFOLD requirement: MS-OXCFOLD_R586.
// MS-OXCFOLD_R10163 is verified, MS-OXCFOLD_R586 can be verified directly.
Site.CaptureRequirement(
586,
@"[In Processing a RopMoveCopyMessages ROP Request] If the server fails to move or copy any message, it sets the PartialCompletion field of the RopMoveCopyMessages ROP response buffer to nonzero (TRUE), as specified in section 2.2.1.6.2.");
}
#endregion
}
/// <summary>
/// Verify RopDeleteMessages Response
/// </summary>
/// <param name="ropDeleteMessageResponse">The response of RopDeleteMessages request</param>
/// <param name="inputHandleIndex">The field of InputHandleIndex in RopDeleteMessages request</param>
private void VerifyRopDeleteMessagesResponse(RopDeleteMessagesResponse ropDeleteMessageResponse, byte inputHandleIndex)
{
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R944");
// Verify MS-OXCROPS requirement: MS-OXCROPS_R944
Site.CaptureRequirementIfAreEqual<Type>(
typeof(byte),
ropDeleteMessageResponse.RopId.GetType(),
944,
@"[In RopDeleteMessages ROP Response Buffer] RopId (1 byte): An unsigned integer.");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R946");
// Verify MS-OXCROPS requirement: MS-OXCROPS_R946
Site.CaptureRequirementIfAreEqual<byte>(
(byte)RopId.RopDeleteMessages,
ropDeleteMessageResponse.RopId,
946,
@"[In RopDeleteMessages ROP Response Buffer] RopId (1 byte): For this operation[RopDeleteMessages], this field[RopId (1 byte)] is set to 0x1E.");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R947");
// Verify MS-OXCROPS requirement: MS-OXCROPS_R947
Site.CaptureRequirementIfAreEqual<Type>(
typeof(byte),
ropDeleteMessageResponse.InputHandleIndex.GetType(),
947,
@"[In RopDeleteMessages ROP Response Buffer] InputHandleIndex (1 byte): An unsigned integer.");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R948");
// Verify MS-OXCROPS requirement: MS-OXCROPS_R948
Site.CaptureRequirementIfAreEqual<byte>(
inputHandleIndex,
ropDeleteMessageResponse.InputHandleIndex,
948,
@"[In RopDeleteMessages ROP Response Buffer] InputHandleIndex (1 byte): This index MUST be set to the value specified in the InputHandleIndex field in the request.");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R949");
// Verify MS-OXCROPS requirement: MS-OXCROPS_R949
Site.CaptureRequirementIfAreEqual<Type>(
typeof(uint),
ropDeleteMessageResponse.ReturnValue.GetType(),
949,
@"[In RopDeleteMessages ROP Response Buffer] ReturnValue (4 bytes): An unsigned integer.");
// Add the debug information
Site.Log.Add(LogEntryKind.Debug, "Verify MS-OXCROPS_R951,PartialCompletion:{0}", ropDeleteMessageResponse.PartialCompletion);
// Verify MS-OXCROPS requirement: MS-OXCROPS_R951
// If PartialCompletion is byte type and can be boolean type representation, then verify R951
bool isVerifyR951 = (typeof(byte) == ropDeleteMessageResponse.PartialCompletion.GetType()) &&
((Convert.ToBoolean(ropDeleteMessageResponse.PartialCompletion) == true) ||
(Convert.ToBoolean(ropDeleteMessageResponse.PartialCompletion) == false));
Site.CaptureRequirementIfIsTrue(
isVerifyR951,
951,
@"[In RopDeleteMessages ROP Response Buffer] PartialCompletion (1 byte): A Boolean.");
}
