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

Inheritance: Microsoft.Protocols.TestTools.TestClassBase

Show file Open project: OfficeDev/Interop-TestSuites

Protected Methods

Method	Description
CheckWhetherSupportTransport ( ) : void	Check whether support MS-OXCMAPIHTTP or ncacn_ip_tcp transport.
CreateFolder ( uint parentFolderHandle, string folderName, ulong &folderId, uint &folderHandle ) : RopCreateFolderResponse	Creates a new Folder.
CreateSampleRuleDataArrayForAdd ( ) : Microsoft.Protocols.TestSuites.Common.RuleData[]	Create sample RuleData array to modify the rules associated with a folder.
CreateSaveMessage ( uint folderHandle, ulong folderId, byte associatedFlag, ulong &messageId, uint &messageHandle ) : void	Create and save message.
CreateSaveMessage ( uint folderHandle, ulong folderId, ulong &messageId, uint &messageHandle ) : void	Create and save message.
GenericFolderInitialization ( ) : void	Initialize a generic folder under inbox as a root folder for test.
GetContentsTable ( FolderTableFlags flags, uint inputHandle ) : uint	Get row count of a specified folder's contents table.
GetSubfolderIDByName ( ulong parentFolderId, uint logonHandle, string folderName ) : ulong	Find a folder ID in the specified folder and with specified display name.
GetTableRowValue ( uint tableHandle, ushort rowCount, PropertyTag properties ) : List	Get the properties' value from the rows of the table.
IsFolderDeleted ( ulong folderId ) : bool	Verify whether the specified folder was deleted.
IsFolderHardDeleted ( ulong folderId ) : bool	Verify whether the specified folder was hard deleted.
IsFolderSoftDeleted ( ulong folderId ) : bool	Verify whether the specified folder was soft deleted.
IsMessageDeleted ( ulong messageId, ulong folderId ) : bool	Verify whether the specified message in specified folder was deleted.
Logon ( LogonFlags logonType, uint &objHandle ) : RopLogonResponse	Logon Mail server.
Logon ( LogonFlags logonType, uint &objHandle, uint openFlags ) : RopLogonResponse	Logon Mail server.
OpenFolder ( uint inputHandle, ulong folderId, uint &folderHandle ) : RopOpenFolderResponse	Opens an existing folder.
OpenMessage ( ulong messageId, ulong folderId, MessageOpenModeFlags openModeFlags ) : RopOpenMessageResponse	Open a specified message in specified folder.
TestCleanup ( ) : void	Overrides TestClassBase's TestCleanup()
TestInitialize ( ) : void	Test initialize. Overrides the method TestInitialize defined in base class.

Method Details

CheckWhetherSupportTransport() protected method

Check whether support MS-OXCMAPIHTTP or ncacn_ip_tcp transport.

protected CheckWhetherSupportTransport ( ) : void
return	void

CreateFolder() protected method

Creates a new Folder.

protected CreateFolder ( uint parentFolderHandle, string folderName, ulong &folderId, uint &folderHandle ) : RopCreateFolderResponse
parentFolderHandle	uint	The parent folder under which the new folder will be created.
folderName	string	Folder Name which will be created.
folderId	ulong	Folder Id which will be returned by server.
folderHandle	uint	Folder Handle which will be returned by server.
return	Microsoft.Protocols.TestSuites.Common.RopCreateFolderResponse

CreateSampleRuleDataArrayForAdd() protected method

Create sample RuleData array to modify the rules associated with a folder.

protected CreateSampleRuleDataArrayForAdd ( ) : Microsoft.Protocols.TestSuites.Common.RuleData[]
return	Microsoft.Protocols.TestSuites.Common.RuleData[]

CreateSaveMessage() protected method

Create and save message.

protected CreateSaveMessage ( uint folderHandle, ulong folderId, byte associatedFlag, ulong &messageId, uint &messageHandle ) : void
folderHandle	uint	Folder Handle
folderId	ulong	Folder Id which messages will be create in.
associatedFlag	byte	Specifies whether the message is a Folder Associated Information message.
messageId	ulong	Message Id which will be returned by server.
messageHandle	uint	Message Handle which will be returned by server.
return	void

CreateSaveMessage() protected method

Create and save message.

protected CreateSaveMessage ( uint folderHandle, ulong folderId, ulong &messageId, uint &messageHandle ) : void
folderHandle	uint	Folder Handle
folderId	ulong	Folder Id which messages will be create in.
messageId	ulong	Message Id which will be returned by server.
messageHandle	uint	Message Handle which will be returned by server.
return	void

GenericFolderInitialization() protected method

Initialize a generic folder under inbox as a root folder for test.

protected GenericFolderInitialization ( ) : void
return	void

GetContentsTable() protected method

Get row count of a specified folder's contents table.

protected GetContentsTable ( FolderTableFlags flags, uint inputHandle ) : uint
flags	FolderTableFlags	The TableFlags parameter contains a bitmask of flags that control how information is returned in the table on folder.
inputHandle	uint	The folder object handle.
return	uint

GetSubfolderIDByName() protected method

Find a folder ID in the specified folder and with specified display name.

protected GetSubfolderIDByName ( ulong parentFolderId, uint logonHandle, string folderName ) : ulong
parentFolderId	ulong	ID of the parent Folder.
logonHandle	uint	The logon object handle.
folderName	string	The folder display name.
return	ulong

GetTableRowValue() protected method

Get the properties' value from the rows of the table.

protected GetTableRowValue ( uint tableHandle, ushort rowCount, PropertyTag properties ) : List
tableHandle	uint	The table handle.
rowCount	ushort	The amount of the rows.
properties	Microsoft.Protocols.TestSuites.Common.PropertyTag	The properties need to show.
return	List

IsFolderDeleted() protected method

Verify whether the specified folder was deleted.

protected IsFolderDeleted ( ulong folderId ) : bool
folderId	ulong	The specified folder ID.
return	bool

IsFolderHardDeleted() protected method

Verify whether the specified folder was hard deleted.

protected IsFolderHardDeleted ( ulong folderId ) : bool
folderId	ulong	The specified folder ID.
return	bool

IsFolderSoftDeleted() protected method

Verify whether the specified folder was soft deleted.

protected IsFolderSoftDeleted ( ulong folderId ) : bool
folderId	ulong	The specified folder ID.
return	bool

IsMessageDeleted() protected method

Verify whether the specified message in specified folder was deleted.

protected IsMessageDeleted ( ulong messageId, ulong folderId ) : bool
messageId	ulong	The specified message ID.
folderId	ulong	The specified folder ID.
return	bool

Logon() protected method

Logon Mail server.

protected Logon ( LogonFlags logonType, uint &objHandle ) : RopLogonResponse
logonType	LogonFlags	Logon Type.
objHandle	uint	Server response handle.
return	Microsoft.Protocols.TestSuites.Common.RopLogonResponse

Logon() protected method

Logon Mail server.

protected Logon ( LogonFlags logonType, uint &objHandle, uint openFlags ) : RopLogonResponse
logonType	LogonFlags	Logon Type.
objHandle	uint	Server response handle.
openFlags	uint	The possible values are specified in [MS-OXCSTOR]. This structure contains more flags that control the behavior of the logon.
return	Microsoft.Protocols.TestSuites.Common.RopLogonResponse

OpenFolder() protected method

Opens an existing folder.

protected OpenFolder ( uint inputHandle, ulong folderId, uint &folderHandle ) : RopOpenFolderResponse
inputHandle	uint	The input Server object for this operation is a Logon object or a Folder object that represents the object to be opened.
folderId	ulong	The folder ID specifies the folder to be opened.
folderHandle	uint	A Folder object that represents the folder that was opened.
return	Microsoft.Protocols.TestSuites.Common.RopOpenFolderResponse

OpenMessage() protected method

Open a specified message in specified folder.

protected OpenMessage ( ulong messageId, ulong folderId, MessageOpenModeFlags openModeFlags ) : RopOpenMessageResponse
messageId	ulong	The specified message ID.
folderId	ulong	The specified folder ID.
openModeFlags	MessageOpenModeFlags	OpenModeFlags for RopOpenMessage.
return	Microsoft.Protocols.TestSuites.Common.RopOpenMessageResponse

TestCleanup() protected method

Overrides TestClassBase's TestCleanup()

protected TestCleanup ( ) : void
return	void

TestInitialize() protected method

Test initialize. Overrides the method TestInitialize defined in base class.

protected TestInitialize ( ) : void
return	void