Skip to content

IAdmMoveExchangeMailboxOps

The IAdmMoveExchangeMailboxOps interface provides methods to perform mailbox moves.

Inheritance: The IAdmMoveExchangeMailboxOps interface inherits from the IUnknown interface.

Note

To move mailboxes to and from Microsoft 365, use the IAdmMoveExchangeMailboxOps2 interface.

Methods

Details

CreateMoveMailboxRequest()

Starts the process of an asynchronous move of the user’s mailbox and/or personal archive.

void CreateMoveMailboxRequest(String primaryMailboxTargetDatabase,
                              String archiveMailboxTargetDatabase,
                              Int32 badItemLimit,
                              Int32 largeItemLimit)

Parameters

  • primaryMailboxTargetDatabase - Specifies the ADS path of the mailbox database for the primary mailbox. If the parameter is NULL, the primary mailbox will not be moved.
  • archiveMailboxTargetDatabase - Specifies the ADS path of the mailbox database for the archive mailbox. If the parameter is NULL, the archive mailbox will not be moved.
  • badItemLimit - Specifies the number of bad items to skip if the request encounters corruption in the mailbox. Use 0 to not skip bad items. The valid input range for this parameter is from 0 through 2147483647.
  • largeItemLimit - Specifies the number of large items to skip if the request encounters such items in the mailbox. Use 0 to not skip any large items.

Examples

Moving mailboxes


GetMoveMailboxRequestInfo()

Gets the detailed status of an ongoing asynchronous mailbox move.

IAdmMoveExchangeMailboxRequestInfo GetMoveMailboxRequestInfo(Boolean includeReport)

Parameters

The includeReport parameter specifies whether to return additional details, which can be used for troubleshooting. The details will be loaded to the IAdmMoveExchangeMailboxRequestInfo::DetailedLog property.

Remarks

If there are no move requests associated with the mailbox, the method returns an empty instance of the IAdmMoveExchangeMailboxRequestInfo interface.


CancelMoveMailboxRequest()

Cancels an ongoing mailbox move.

void CancelMoveMailboxRequest()

DeleteMoveMailboxRequest()

Deletes the current mailbox move request.

void DeleteMoveMailboxRequest()

Requirements

Minimum required version: 2013.1

See also