C# Class Microsoft.Protocols.TestSuites.MS_OXWSSYNC.MS_OXWSSYNCSUTControlAdapter

MS-OXWSSYNC SUT control adapter implementation.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_OXWSSYNCSUTControlAdapter

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
CleanupMailBox ( string userName, string userPassword, string userDomain ) : bool	Log on to a mailbox with a specified user account and delete all the items and subfolders from Inbox, Sent Items, Calendar, Contacts, Tasks, Deleted Items and Search Folders if any.
FindAndAcceptMeetingMessage ( string userName, string userPassword, string userDomain, string itemSubject, string itemType ) : bool	Log on to a mailbox with a specified user account and find the specified meeting message in the Inbox folder, then accept it.
FindAndDeleteItem ( string userName, string userPassword, string userDomain, string folderName, string itemSubject, string itemType ) : bool	Log on to a mailbox with a specified user account and find the specified item then delete it.
FindAndDeleteSubFolder ( string userName, string userPassword, string userDomain, string parentFolderName, string subFolderName ) : bool	Log on to a mailbox with a specified user account and find the specified folder, then delete it if it is found.
FindAndUpdateFolderName ( string userName, string userPassword, string userDomain, string parentFolderName, string currentFolderName, string newFolderName ) : bool	Log on to a mailbox with a specified user account and find the specified folder then update the folder name of it.
Initialize ( TestTools testSite ) : void	Overrides IAdapter's Initialize() and sets default protocol short name of the testSite.
IsCalendarItemCanceled ( string userName, string userPassword, string userDomain, string folderName, string itemSubject ) : bool	Log on to a mailbox with a specified user account and check whether the specified calendar item is cancelled or not.
IsItemExisting ( string userName, string userPassword, string userDomain, string folderName, string itemSubject, string itemType ) : bool	Log on a mailbox with a specified user account and check whether the specified item exists.

Private Methods

Method	Description
CleanupFolder ( DistinguishedFolderIdNameType folderName, bool needVerify = true ) : bool	Deletes all items and sub folders from the specified folder.
FindAllItems ( DistinguishedFolderIdNameType folderName ) : Microsoft.Protocols.TestSuites.Common.ItemType[]	Find all the items in the specified folder.
FindAllSubFolders ( DistinguishedFolderIdNameType parentFolderName ) : Microsoft.Protocols.TestSuites.Common.BaseFolderType[]	Find all the sub folders in the specified folder.
FindSubFolder ( DistinguishedFolderIdNameType parentFolderName, string subFolderName ) : FolderIdType	Find the specified sub folder.
LoopToFindItem ( DistinguishedFolderIdNameType folderName, string itemSubject, System.Item itemType ) : ItemType	Loop to find the item with the specified subject.

Method Details

CleanupMailBox() public method

Log on to a mailbox with a specified user account and delete all the items and subfolders from Inbox, Sent Items, Calendar, Contacts, Tasks, Deleted Items and Search Folders if any.

public CleanupMailBox ( string userName, string userPassword, string userDomain ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
return	bool

FindAndAcceptMeetingMessage() public method

Log on to a mailbox with a specified user account and find the specified meeting message in the Inbox folder, then accept it.

public FindAndAcceptMeetingMessage ( string userName, string userPassword, string userDomain, string itemSubject, string itemType ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
itemSubject	string	Subject of the meeting message which should be accepted.
itemType	string	Type of the item which should be accepted.
return	bool

FindAndDeleteItem() public method

Log on to a mailbox with a specified user account and find the specified item then delete it.

public FindAndDeleteItem ( string userName, string userPassword, string userDomain, string folderName, string itemSubject, string itemType ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
folderName	string	Name of the folder which should be searched for the specified item.
itemSubject	string	Subject of the item which should be deleted.
itemType	string	Type of the item which should be deleted.
return	bool

FindAndDeleteSubFolder() public method

Log on to a mailbox with a specified user account and find the specified folder, then delete it if it is found.

public FindAndDeleteSubFolder ( string userName, string userPassword, string userDomain, string parentFolderName, string subFolderName ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
parentFolderName	string	Name of the parent folder.
subFolderName	string	Name of the folder which will be updated.
return	bool

FindAndUpdateFolderName() public method

Log on to a mailbox with a specified user account and find the specified folder then update the folder name of it.

public FindAndUpdateFolderName ( string userName, string userPassword, string userDomain, string parentFolderName, string currentFolderName, string newFolderName ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
parentFolderName	string	Name of the parent folder.
currentFolderName	string	Current name of the folder which will be updated.
newFolderName	string	New name of the folder which will be updated to.
return	bool

Initialize() public method

Overrides IAdapter's Initialize() and sets default protocol short name of the testSite.

public Initialize ( TestTools testSite ) : void
testSite	TestTools	Pass ITestSite to adapter, make adapter can use ITestSite's function
return	void

IsCalendarItemCanceled() public method

Log on to a mailbox with a specified user account and check whether the specified calendar item is cancelled or not.

public IsCalendarItemCanceled ( string userName, string userPassword, string userDomain, string folderName, string itemSubject ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
folderName	string	Name of the folder which should be searched for the specified meeting message.
itemSubject	string	Subject of the meeting message which should exist.
return	bool

IsItemExisting() public method

Log on a mailbox with a specified user account and check whether the specified item exists.

public IsItemExisting ( string userName, string userPassword, string userDomain, string folderName, string itemSubject, string itemType ) : bool
userName	string	Name of the user.
userPassword	string	Password of the user.
userDomain	string	Domain of the user.
folderName	string	Name of the folder which should be searched for the specified item.
itemSubject	string	Subject of the item which should exist.
itemType	string	Type of the item which should exist.
return	bool