Operations at MailboxRestoreManagement
This page describes the backend methods at this endpoint.
| Signature | Description |
|---|---|
| Void CloseDatabase(String databaseId) | Closes the database. |
| Void ContinueRestore(String restoreJobId) | Continues execution of mail restore job. It is only used for cases when error handling mode was set to Notify and there was an error during job execution. |
| Void CopyRequiredDlls(CopyRequiredDllsRequest request) | Copies specified Exchange libraries from a local or network path to the special location. |
| MrRestoreSession CreateRestoreSession(String displayName, BaseCredentials credentials) | Creates a new restore session. |
| ExchangeDllFileCollection DownloadRequiredDlls(String exchangeVersion) | Downloads Exchange libraries to client. |
| MrFoundItemCollection GetAllSearchResultsReduced(String id) | Returns a collection of all found by search job items. Note: some fields like folder items' from / to / subject / etc may be empty for saving memory and better performance. |
| MailboxRestoreServiceConfiguration GetConfiguration() | Sets AutoUpdate configuration. |
| ExchangeServerVersion GetExchangeVersion(OpenExchangeDatabaseRequest request) | Determines version of Exchange for the specified database or for the specified recovery point Id. |
| GetFolderItemsResponse GetFilteredMrFolderItemsByPage(String max, String page, MrFolderItemFilter filter) | Returns a collection of folders items inside of a folder, on the specified page, in sorted and filtered state. |
| GetSearchResultsResponse GetFilteredSearchResultsByPage(String max, String page, MrSearchResultsFilter filter) | Returns a collection of found by search job items, on the specified page, in sorted and filtered state. |
| MrFolderCollection GetFolders(GetFoldersRequest request) | Returns a collection of folders inside of the open database. |
| AddressBookEntryCollection GetGlobalAddressBook(String restoreSessionId, String profileName) | Returns a collection of entries in the global address book. |
| MrMailboxCollection GetMailboxes(String databaseId) | Returns a collections of mailboxes inside of the open database. |
| MapiProfileCollection GetMapiProfiles(String restoreSessionId) | Returns a collection of MAPI profiles. |
| MrDatabaseCollection GetOpenDatabases() | Returns a collection of open databases. |
| ExchangeDllCollection GetRequiredDllsInfo(GetRequiredDllsInfoRequest request) | Retrieves information about required Exchange libraries for the given version of Exchange from the specified server, the specified directory or UNC path. |
| ExchangeDllCollection GetRequiredExchangeDlls(ExchangeServerVersion version) | Returns a collection of required Exchange dlls (ese.dll, exchmem.dll etc) for the specified version of Exchange. |
| MrRestoreSessionCollection GetRestoreSessions() | Returns a collection of currently existing restore sessions. |
| Boolean IsSearchRunning(String id) | Verifies whether the specified search job is running. |
| Guid OpenDatabase(OpenExchangeDatabaseRequest request) | Opens an Exchange database (returns ID of a new background job). |
| Void RemoveRestoreSession(String restoreSessionId) | Removes a restore session. Note: this may cause failure of mail restore jobs which are using the specified session. |
| Void SetConfiguration(MailboxRestoreServiceConfiguration configuration) | Sets AutoUpdate configuration. |
| Guid StartRestore(MrRestoreJobRequest request) | Starts a new mail restore job and returns its identifier. |
| Guid StartSearch(MrSearchJobRequest request) | Starts a new search job and returns its identifier. |
| Void VerifyDatabaseFilePath(String databaseFilePath) | Verifies path of Exchange database file and throws various exceptions if the path is invalid. Note: this check is mandatory; invalid database file cannot be opened. |
| Boolean VerifyDatabaseLogsPath(String logsPath) | Verifies path of Exchange database logs files. Note: this check is optional; if the logs path is invalid, the database still can be opened. |
| Boolean VerifyDatabaseSystemPath(String systemPath) | Verifies path of Exchange database system files. Note: this check is optional; if the system path is invalid, the database still can be opened. |
| Void VerifyExchangeDlls(ExchangeServerVersion version) | Verifies presence of required Exchange dlls (ese.dll, exchmem.dll etc) for the specified version of Exchange. |