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

Inheritance: Microsoft.Protocols.TestTools.TestClassBase

Public Methods

Method	Description
DeliverMessageToTriggerRule ( string mailTo, string mailToUserDN, string subject, TaggedPropertyValue addedProperties ) : uint	Submit a message to the server
GetStoreObjectEntryID ( StoreObjectType storeObjectType, string serverShortName, string mailboxDN ) : byte[]	Get store object EntryID bytes array.
LogonMailbox ( TestUser testUser ) : void	Log on mailbox with specified user.

Method	Description
CheckMAPIHTTPTransportSupported ( ) : void	Disable the test case if MAPIHTTP transport is selected but not supported by current test environment.
CheckUnexpectedMessageExist ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, string unexpectedPropertyValue, PropertyId propertyName = PropertyId.PidTagSubject ) : bool	Check if an unexpected message with a specific property value exists in the target mailbox.
ClearAllRules ( ) : void	Clear all rules of the inbox folder.
GetExpectedMessage ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, int &expectedMessageIndex, string expectedPropertyValue, PropertyId expectedPropertyName = PropertyId.PidTagSubject ) : RopQueryRowsResponse	Get the expected message properties included in a specific contents table after retry preconfigured times.
GetExpectedMessage ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, uint &rowCount, int expectedMessageCount = 1, string expectedTitle = null ) : RopQueryRowsResponse	Get the expected message properties included in a specific contents table and the message count in the table after retry preconfigured times.
GetNotifyResponse ( ) : RopNotifyResponse	Get the Notify response after retry preconfigured times.
TestCleanup ( ) : void	Overrides TestClassBase's TestCleanup()
TestInitialize ( ) : void	Overrides TestClassBase's TestInitialize()
VerifyRuleTable ( ) : void	Verify rule table.

Method	Description
CheckIfTestCaseDisabled ( ) : bool	Check if a specific test case is disabled.

Disable the test case if MAPIHTTP transport is selected but not supported by current test environment.

protected CheckMAPIHTTPTransportSupported ( ) : void
return	void

Check if an unexpected message with a specific property value exists in the target mailbox.

protected CheckUnexpectedMessageExist ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, string unexpectedPropertyValue, PropertyId propertyName = PropertyId.PidTagSubject ) : bool
folderHandle	uint	Handle of a specific folder.
contentsTableHandle	uint	Handle of a specific contents table.
propertyTagList	Microsoft.Protocols.TestSuites.Common.PropertyTag	>Array of PropertyTag structures. This field specifies the property values that are visible in table rows.
unexpectedPropertyValue	string	The value of a specific property of the message to be checked in the target mailbox.
propertyName	Microsoft.Protocols.TestSuites.Common.PropertyId	The property name of a specific property of the message to be checked in the target mailbox, which type should be string. The default property name is PidTagSubject.
return	bool

Clear all rules of the inbox folder.

protected ClearAllRules ( ) : void
return	void

Submit a message to the server

public DeliverMessageToTriggerRule ( string mailTo, string mailToUserDN, string subject, TaggedPropertyValue addedProperties ) : uint
mailTo	string	The user name of the recipient
mailToUserDN	string	The userDN of the recipient
subject	string	The subject of the mail
addedProperties	Microsoft.Protocols.TestSuites.Common.TaggedPropertyValue	The added properties of the mail
return	uint

Get the expected message properties included in a specific contents table after retry preconfigured times.

protected GetExpectedMessage ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, int &expectedMessageIndex, string expectedPropertyValue, PropertyId expectedPropertyName = PropertyId.PidTagSubject ) : RopQueryRowsResponse
folderHandle	uint	Handle of a specific folder.
contentsTableHandle	uint	Handle of a specific contents table.
propertyTagList	Microsoft.Protocols.TestSuites.Common.PropertyTag	>Array of PropertyTag structures. This field specifies the property values that are visible in table rows.
expectedMessageIndex	int	The index of the specific message in the table.
expectedPropertyValue	string	The value of a specific property of the message to be found in the target mailbox.
expectedPropertyName	Microsoft.Protocols.TestSuites.Common.PropertyId	The property name of a specific property of the message to be found in the target mailbox, which type should be string. The default property name is PidTagSubject.
return	Microsoft.Protocols.TestSuites.Common.RopQueryRowsResponse

Get the expected message properties included in a specific contents table and the message count in the table after retry preconfigured times.

protected GetExpectedMessage ( uint folderHandle, uint &contentsTableHandle, PropertyTag propertyTagList, uint &rowCount, int expectedMessageCount = 1, string expectedTitle = null ) : RopQueryRowsResponse
folderHandle	uint	Handle of a specific folder.
contentsTableHandle	uint	Handle of a specific contents table.
propertyTagList	Microsoft.Protocols.TestSuites.Common.PropertyTag	>Array of PropertyTag structures. This field specifies the property values that are visible in table rows.
rowCount	uint	The row count in the specific contents table, in which each row specifies a message.
expectedMessageCount	int	Specify the expected number of messages in target mailbox. The default value is 1.
expectedTitle	string	The default value is null. If the value is not null, the message with specified title must exist in target mailbox. If the expected message exists, the rowCount represents the index of the message in the target mailbox.
return	Microsoft.Protocols.TestSuites.Common.RopQueryRowsResponse

Get the Notify response after retry preconfigured times.

protected GetNotifyResponse ( ) : RopNotifyResponse
return	RopNotifyResponse

Get store object EntryID bytes array.

public GetStoreObjectEntryID ( StoreObjectType storeObjectType, string serverShortName, string mailboxDN ) : byte[]
storeObjectType	StoreObjectType	Identify the store object is a mailbox or a public folder.
serverShortName	string	Server short name string.
mailboxDN	string	Mailbox DN string.
return	byte[]

Log on mailbox with specified user.

public LogonMailbox ( TestUser testUser ) : void
testUser	TestUser	Identify the user to log on to the server.
return	void

Overrides TestClassBase's TestCleanup()

protected TestCleanup ( ) : void
return	void

Overrides TestClassBase's TestInitialize()

protected TestInitialize ( ) : void
return	void

Verify rule table.

protected VerifyRuleTable ( ) : void
return	void