C# Class Microsoft.Protocols.TestSuites.MS_OXCFOLD.MS_OXCFOLDAdapter

Capture code for MS-OXCFOLD adapter.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
CopyFolder ( RopCopyFolderRequest ropCopyFolderRequest, List insideObjHandle, List &responseSOHTable ) : RopCopyFolderResponse	Creates a new folder on the destination parent folder, copying the properties and content of the source folder to the new folder.
CreateFolder ( RopCreateFolderRequest ropCreateFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopCreateFolderResponse	Creates either public folders or private mailbox folders.
DeleteFolder ( RopDeleteFolderRequest ropDeleteFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopDeleteFolderResponse	Removes a subfolder.
DeleteMessages ( RopDeleteMessagesRequest ropDeleteMessagesRequest, uint insideObjHandle, List &responseSOHTable ) : RopDeleteMessagesResponse	Deletes one or more messages from a folder.
DoConnect ( ConnectionType connectionType ) : bool	Connect to the server for RPC calling.
DoConnect ( string server, ConnectionType connectionType, string userDN, string domain, string userName, string password ) : bool	Connect to the server for RPC calling.
DoDisconnect ( ) : bool	Client calls it to disconnect the connection with Server.
DoRopCall ( ISerializable ropRequest, List insideObjHandle, object &ropResponse, List &responseSOHTable ) : uint	Sends ROP request with single operation and multiple input object handles with expected SuccessResponse.
DoRopCall ( ISerializable ropRequest, uint insideObjHandle, object &ropResponse, List &responseSOHTable ) : uint	Sends ROP request with single operation and single input object handle with expected SuccessResponse.
EmptyFolder ( RopEmptyFolderRequest ropEmptyFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopEmptyFolderResponse	Soft deletes all messages and subfolders from a folder without deleting the folder itself.
GetContentsTable ( RopGetContentsTableRequest ropGetContentsTableRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetContentsTableResponse	Retrieves the contents table for a folder.
GetFolderObjectSpecificProperties ( RopGetPropertiesSpecificRequest ropGetPropertiesSpecificRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetPropertiesSpecificResponse	Get folder object specific properties.
GetFolderPropertiesAll ( uint inputHandle, List &responseSOHTable ) : RopGetPropertiesAllResponse	Get all properties of a folder object.
GetHierarchyTable ( RopGetHierarchyTableRequest ropGetHierarchyTableRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetHierarchyTableResponse	Retrieves the hierarchy table for a folder.
GetSearchCriteria ( RopGetSearchCriteriaRequest ropGetSearchCriteriaRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetSearchCriteriaResponse	Obtains the search criteria and the status of a search for a search folder.
HardDeleteMessages ( RopHardDeleteMessagesRequest ropHardDeleteMessagesRequest, uint insideObjHandle, List &responseSOHTable ) : RopHardDeleteMessagesResponse	Hard deletes one or more messages that are listed in the request buffer.
HardDeleteMessagesAndSubfolders ( RopHardDeleteMessagesAndSubfoldersRequest ropHardDeleteMessagesAndSubfoldersRequest, uint insideObjHandle, List &responseSOHTable ) : RopHardDeleteMessagesAndSubfoldersResponse	Hard deletes all messages and subfolders from a folder without deleting the folder itself.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize method, to set testSite.DefaultProtocolDocShortName.
MoveCopyMessages ( RopMoveCopyMessagesRequest ropMoveCopyMessagesRequest, List insideObjHandle, List &responseSOHTable ) : RopMoveCopyMessagesResponse	Moves or copies messages from a source folder to a destination folder.
MoveFolder ( RopMoveFolderRequest ropMoveFolderRequest, List insideObjHandle, List &responseSOHTable ) : RopMoveFolderResponse	Moves a folder from one parent to another.
OpenFolder ( RopOpenFolderRequest ropOpenFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopOpenFolderResponse	Opens an existing folder.
SetFolderObjectProperties ( RopSetPropertiesRequest ropSetPropertiesRequest, uint insideObjHandle, List &responseSOHTable ) : RopSetPropertiesResponse	Set folder object properties.
SetSearchCriteria ( RopSetSearchCriteriaRequest ropSetSearchCriteriaRequest, uint insideObjHandle, List &responseSOHTable ) : RopSetSearchCriteriaResponse	Establishes search criteria for a search folder.

Private Methods

Method	Description
ExcuteRopCall ( ISerializable ropRequest, List insideObjHandle, object &response, List &responseSOHTable, byte &rawData ) : uint	Execute a ROP call.
ExcuteRopCall ( ISerializable ropRequest, uint insideObjHandle, object &response, List &responseSOHTable, byte &rawData ) : uint	Execute a ROP call.
VerifyFolderIDStructure ( byte folderIdStructure ) : void	Verify the Folder ID Structure.
VerifyGetFolderPropertiesAll ( RopGetPropertiesAllResponse response ) : void	Verify the response of RopGetPropertiesAll ROP operation.
VerifyGetFolderSpecificProperties ( PropertyTag propertyTags ) : void	Verify the specific property.
VerifyPtypBinary ( byte ptypBinary ) : void	Verify the type of PtypBinary
VerifyPtypBoolean ( byte ptypBoolean ) : void	Verify the type of PtypBoolean
VerifyPtypInteger32 ( byte ptypInteger32 ) : void	Verify the type of PtypInteger32.
VerifyPtypInteger64 ( byte ptypInteger64 ) : void	Verify the type of PtypInteger64
VerifyPtypString ( byte bytes ) : void	Verify if the bytes is PtypString type
VerifyPtypTime ( byte ptypTime ) : void	Verify the type of PtypTime
VerifyRPCLayerRequirement ( ) : void	Verify RPC layer requirement
VerifyRopCopyFolder ( RopCopyFolderResponse copyFolderResponse ) : void	Verify the response of RopCopyFolder ROP operation.
VerifyRopCreateFolder ( RopCreateFolderResponse createFolderResponse ) : void	Verify the response of RopCreateFolder ROP operation.
VerifyRopDeleteFolder ( RopDeleteFolderResponse deleteFolderResponse ) : void	Verify the response of RopDeleteFolder ROP operation.
VerifyRopDeleteMessages ( RopDeleteMessagesResponse deleteMessagesResponse ) : void	Verify the response of RopDeleteMessages ROP operation.
VerifyRopEmptyFolder ( RopEmptyFolderResponse emptyFolderResponse ) : void	Verify the response of RopEmptyFolder ROP operation.
VerifyRopGetContentsTable ( RopGetContentsTableResponse getContentsTableResponse ) : void	Verify the response of RopGetContentsTable ROP operation.
VerifyRopGetHierarchyTable ( RopGetHierarchyTableResponse getHierarchyTableResponse ) : void	Verify the response of RopGetHierarchyTable ROP operation.
VerifyRopGetSearchCriteria ( RopGetSearchCriteriaResponse getSearchCriteriaResponse ) : void	Verify the response of RopGetSearchCriteria ROP operation.
VerifyRopHardDeleteMessages ( RopHardDeleteMessagesResponse hardDeleteMessages ) : void	Verify the response of RopHardDeleteMessages ROP operation.
VerifyRopHardDeleteMessagesAndSubfolders ( RopHardDeleteMessagesAndSubfoldersResponse hardDeleteMessagesAndSubfoldersResponse ) : void	Verify the response of RopHardDeleteMessagesAndSubfolders ROP operation.
VerifyRopMoveCopyMessages ( RopMoveCopyMessagesResponse moveCopyMessagesResponse ) : void	Verify the response of RopMoveCopyMessages ROP operation.
VerifyRopMoveFolder ( RopMoveFolderResponse moveFolderResponse ) : void	Verify the response of RopMoveFolder ROP operation.
VerifyRopOpenFolder ( RopOpenFolderResponse openFolderResponse ) : void	Verify the response of RopOpenFolder ROP operation.
VerifyRopSetSearchCriteria ( RopSetSearchCriteriaResponse setSearchCriteriaResponse ) : void	Verify the response of RopSetSearchCriteria ROP operation.
VerifyTransport ( ) : void	Verify MAPIHTTP transport.

Method Details

CopyFolder() public method

Creates a new folder on the destination parent folder, copying the properties and content of the source folder to the new folder.

public CopyFolder ( RopCopyFolderRequest ropCopyFolderRequest, List insideObjHandle, List &responseSOHTable ) : RopCopyFolderResponse
ropCopyFolderRequest	Microsoft.Protocols.TestSuites.Common.RopCopyFolderRequest	RopCopyFolderRequest object.
insideObjHandle	List	Server object handles in RopCopyFolderRequest.
responseSOHTable	List	Server objects handles in RopCopyFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopCopyFolderResponse

CreateFolder() public method

Creates either public folders or private mailbox folders.

public CreateFolder ( RopCreateFolderRequest ropCreateFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopCreateFolderResponse
ropCreateFolderRequest	Microsoft.Protocols.TestSuites.Common.RopCreateFolderRequest	RopCreateFolderRequest object.
insideObjHandle	uint	Server object handle in RopCreateFolderRequest.
responseSOHTable	List	Server objects handles in RopCreateFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopCreateFolderResponse

DeleteFolder() public method

Removes a subfolder.

public DeleteFolder ( RopDeleteFolderRequest ropDeleteFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopDeleteFolderResponse
ropDeleteFolderRequest	Microsoft.Protocols.TestSuites.Common.RopDeleteFolderRequest	RopDeleteFolderRequest object.
insideObjHandle	uint	Server object handle in RopDeleteFolderRequest.
responseSOHTable	List	Server objects handles in RopDeleteFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopDeleteFolderResponse

DeleteMessages() public method

Deletes one or more messages from a folder.

public DeleteMessages ( RopDeleteMessagesRequest ropDeleteMessagesRequest, uint insideObjHandle, List &responseSOHTable ) : RopDeleteMessagesResponse
ropDeleteMessagesRequest	RopDeleteMessagesRequest	RopDeleteMessagesRequest object.
insideObjHandle	uint	Server object handle in RopDeleteMessages.
responseSOHTable	List	Server objects handles in RopDeleteMessagesResponse.
return	RopDeleteMessagesResponse

DoConnect() public method

Connect to the server for RPC calling.

public DoConnect ( ConnectionType connectionType ) : bool
connectionType	ConnectionType	The type of connection
return	bool

DoConnect() public method

Connect to the server for RPC calling.

public DoConnect ( string server, ConnectionType connectionType, string userDN, string domain, string userName, string password ) : bool
server	string	Server to connect.
connectionType	ConnectionType	the type of connection
userDN	string	UserDN used to connect server.
domain	string	The domain the server is deployed.
userName	string	The domain account name.
password	string	Password value.
return	bool

DoDisconnect() public method

Client calls it to disconnect the connection with Server.

public DoDisconnect ( ) : bool
return	bool

DoRopCall() public method

Sends ROP request with single operation and multiple input object handles with expected SuccessResponse.

public DoRopCall ( ISerializable ropRequest, List insideObjHandle, object &ropResponse, List &responseSOHTable ) : uint
ropRequest	ISerializable	ROP request object.
insideObjHandle	List	The list of server object handles in request.
ropResponse	object	ROP response object.
responseSOHTable	List	Server objects handles in response.
return	uint

DoRopCall() public method

Sends ROP request with single operation and single input object handle with expected SuccessResponse.

public DoRopCall ( ISerializable ropRequest, uint insideObjHandle, object &ropResponse, List &responseSOHTable ) : uint
ropRequest	ISerializable	ROP request object.
insideObjHandle	uint	Server object handle in request.
ropResponse	object	ROP response object.
responseSOHTable	List	Server objects handles in response.
return	uint

EmptyFolder() public method

Soft deletes all messages and subfolders from a folder without deleting the folder itself.

public EmptyFolder ( RopEmptyFolderRequest ropEmptyFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopEmptyFolderResponse
ropEmptyFolderRequest	Microsoft.Protocols.TestSuites.Common.RopEmptyFolderRequest	RopEmptyFolderRequest object.
insideObjHandle	uint	Server object handle in EmptyFolderRequest.
responseSOHTable	List	Server objects handles in RopEmptyFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopEmptyFolderResponse

GetContentsTable() public method

Retrieves the contents table for a folder.

public GetContentsTable ( RopGetContentsTableRequest ropGetContentsTableRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetContentsTableResponse
ropGetContentsTableRequest	Microsoft.Protocols.TestSuites.Common.RopGetContentsTableRequest	RopGetContentsTableRequest object.
insideObjHandle	uint	Server object handle in RopGetContentsTable.
responseSOHTable	List	Server objects handles in RopGetContentsTableResponse.
return	Microsoft.Protocols.TestSuites.Common.RopGetContentsTableResponse

GetFolderObjectSpecificProperties() public method

Get folder object specific properties.

public GetFolderObjectSpecificProperties ( RopGetPropertiesSpecificRequest ropGetPropertiesSpecificRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetPropertiesSpecificResponse
ropGetPropertiesSpecificRequest	Microsoft.Protocols.TestSuites.Common.RopGetPropertiesSpecificRequest	RopGetPropertiesSpecificRequest object
insideObjHandle	uint	Server object handle in GetPropertiesSpecific.
responseSOHTable	List	Server objects handles in RopGetPropertiesSpecificResponse.
return	Microsoft.Protocols.TestSuites.Common.RopGetPropertiesSpecificResponse

GetFolderPropertiesAll() public method

Get all properties of a folder object.

public GetFolderPropertiesAll ( uint inputHandle, List &responseSOHTable ) : RopGetPropertiesAllResponse
inputHandle	uint	The handle specified the folder RopGetPropertiesAll Rop operation performs on.
responseSOHTable	List	Server objects handles in RopGetPropertiesSpecificResponse.
return	Microsoft.Protocols.TestSuites.Common.RopGetPropertiesAllResponse

GetHierarchyTable() public method

Retrieves the hierarchy table for a folder.

public GetHierarchyTable ( RopGetHierarchyTableRequest ropGetHierarchyTableRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetHierarchyTableResponse
ropGetHierarchyTableRequest	RopGetHierarchyTableRequest	RopGetHierarchyTableRequest object.
insideObjHandle	uint	Server object handle RopGetHierarchyTable.
responseSOHTable	List	Server objects handles in RopGetHierarchyTableResponse.
return	RopGetHierarchyTableResponse

GetSearchCriteria() public method

Obtains the search criteria and the status of a search for a search folder.

public GetSearchCriteria ( RopGetSearchCriteriaRequest ropGetSearchCriteriaRequest, uint insideObjHandle, List &responseSOHTable ) : RopGetSearchCriteriaResponse
ropGetSearchCriteriaRequest	Microsoft.Protocols.TestSuites.Common.RopGetSearchCriteriaRequest	RopGetSearchCriteriaRequest object.
insideObjHandle	uint	Server object handle in RopGetSearchCriteriaRequest.
responseSOHTable	List	Server objects handles in RopGetSearchCriteriaResponse.
return	Microsoft.Protocols.TestSuites.Common.RopGetSearchCriteriaResponse

HardDeleteMessages() public method

Hard deletes one or more messages that are listed in the request buffer.

public HardDeleteMessages ( RopHardDeleteMessagesRequest ropHardDeleteMessagesRequest, uint insideObjHandle, List &responseSOHTable ) : RopHardDeleteMessagesResponse
ropHardDeleteMessagesRequest	Microsoft.Protocols.TestSuites.Common.RopHardDeleteMessagesRequest	RopHardDeleteMessagesRequest object.
insideObjHandle	uint	Server object handle in RopHardDeleteMessages.
responseSOHTable	List	Server objects handles in RopHardDeleteMessagesResponse.
return	Microsoft.Protocols.TestSuites.Common.RopHardDeleteMessagesResponse

HardDeleteMessagesAndSubfolders() public method

Hard deletes all messages and subfolders from a folder without deleting the folder itself.

public HardDeleteMessagesAndSubfolders ( RopHardDeleteMessagesAndSubfoldersRequest ropHardDeleteMessagesAndSubfoldersRequest, uint insideObjHandle, List &responseSOHTable ) : RopHardDeleteMessagesAndSubfoldersResponse
ropHardDeleteMessagesAndSubfoldersRequest	Microsoft.Protocols.TestSuites.Common.RopHardDeleteMessagesAndSubfoldersRequest	RopHardDeleteMessagesAndSubfoldersRequest object.
insideObjHandle	uint	Server object handle in RopHardDeleteMessagesAndSubfolders.
responseSOHTable	List	Server objects handles in RopHardDeleteMessagesAndSubfoldersResponse.
return	Microsoft.Protocols.TestSuites.Common.RopHardDeleteMessagesAndSubfoldersResponse

Initialize() public method

Overrides IAdapter's Initialize method, to set testSite.DefaultProtocolDocShortName.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	Transfer ITestSite into adapter, make adapter can use ITestSite's function.
return	void

MoveCopyMessages() public method

Moves or copies messages from a source folder to a destination folder.

public MoveCopyMessages ( RopMoveCopyMessagesRequest ropMoveCopyMessagesRequest, List insideObjHandle, List &responseSOHTable ) : RopMoveCopyMessagesResponse
ropMoveCopyMessagesRequest	Microsoft.Protocols.TestSuites.Common.RopMoveCopyMessagesRequest	RopMoveCopyMessagesRequest object.
insideObjHandle	List	Server object handles in RopMoveCopyMessagesRequest.
responseSOHTable	List	Server objects handles in RopMoveCopyMessagesResponse.
return	Microsoft.Protocols.TestSuites.Common.RopMoveCopyMessagesResponse

MoveFolder() public method

Moves a folder from one parent to another.

public MoveFolder ( RopMoveFolderRequest ropMoveFolderRequest, List insideObjHandle, List &responseSOHTable ) : RopMoveFolderResponse
ropMoveFolderRequest	Microsoft.Protocols.TestSuites.Common.RopMoveFolderRequest	RopMoveFolderRequest object.
insideObjHandle	List	Server object handles in RopMoveFolderRequest.
responseSOHTable	List	Server objects handles in RopMoveFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopMoveFolderResponse

OpenFolder() public method

Opens an existing folder.

public OpenFolder ( RopOpenFolderRequest ropOpenFolderRequest, uint insideObjHandle, List &responseSOHTable ) : RopOpenFolderResponse
ropOpenFolderRequest	Microsoft.Protocols.TestSuites.Common.RopOpenFolderRequest	RopOpenFolderRequest object.
insideObjHandle	uint	Server object handle in RopOpenFolderRequest.
responseSOHTable	List	Server objects handles in RopOpenFolderResponse.
return	Microsoft.Protocols.TestSuites.Common.RopOpenFolderResponse

SetFolderObjectProperties() public method

Set folder object properties.

public SetFolderObjectProperties ( RopSetPropertiesRequest ropSetPropertiesRequest, uint insideObjHandle, List &responseSOHTable ) : RopSetPropertiesResponse
ropSetPropertiesRequest	Microsoft.Protocols.TestSuites.Common.RopSetPropertiesRequest	RopSetPropertiesRequest object.
insideObjHandle	uint	Server object handle in SetProperties.
responseSOHTable	List	Server objects handles in RopSetPropertiesResponse.
return	Microsoft.Protocols.TestSuites.Common.RopSetPropertiesResponse

SetSearchCriteria() public method

Establishes search criteria for a search folder.

public SetSearchCriteria ( RopSetSearchCriteriaRequest ropSetSearchCriteriaRequest, uint insideObjHandle, List &responseSOHTable ) : RopSetSearchCriteriaResponse
ropSetSearchCriteriaRequest	Microsoft.Protocols.TestSuites.Common.RopSetSearchCriteriaRequest	RopSetSearchCriteriaRequest object.
insideObjHandle	uint	Server object handle in RopSetSearchCriteriaRequest.
responseSOHTable	List	Server objects handles in RopSetSearchCriteriaResponse.
return	Microsoft.Protocols.TestSuites.Common.RopSetSearchCriteriaResponse