Disable Mailbox operation

The Disable Mailbox process disables the mailbox of an existing user or InetOrgPerson and removes the object's Exchange attributes from the Active Directory directory service. The user account associated with the mailbox will remain in Active Directory but will no longer be associated with a mailbox.

The adapter request parameters may differ according to the Microsoft Exchange Server version.

For the list of all supported parameters, refer to the cmdlet in the Microsoft Exchange documentation specific to your version.

The following figure shows a sample adapter request for the operation on Microsoft Exchange version 2016:

<microsoft-exchange-request>
    <command>
      <command-name>Disable-Mailbox</command-name>
      <format-option />
      <verbose-logging />
      <parameters>
        <parameter>
          <name>identity</name>
          <value>allen</value>
        </parameter>
      </parameters>
    </command>
</microsoft-exchange-request>

The following figure shows the response for the adapter request:

microsoft-exchange-response>
  <metadata>
    <status>success</status>
  </metadata>
  <targets-output>
    <target-output host="clm-pun-020413.bmc.com">
      <metadata>
        <os-id>Windows Server 2008</os-id>
        <os-version>6.3.9600</os-version>
        <status>success</status>
      </metadata>
      <commands-output>
        <command-output>
          <metadata>
            <command>Disable-Mailbox -identity:allen -confirm:$false</command>
            <line-count>5</line-count>
            <execution-milliseconds>70012</execution-milliseconds>
            <exit-code>0</exit-code>
            <status>success</status>
          </metadata>
          <output>
            <line index="1">Attempting to connect to remote host...</line>
            <line index="2">Initialising rctrlx server component...</line>
            <line index="3">Executing remote application: cmd /c "echo . | powershell -PSConsoleFile "C:\Program Files\Microsoft\Exchange Server\V15\Bin\exshell.psc1" -NonInteractive -Command Disable-Mailbox -identity:allen -confirm:$false "</line>
            <line index="4">Stdout:</line>
            <line index="5">Remote application exited with code: 0</line>
          </output>
        </command-output>
      </commands-output>
    </target-output>
  </targets-output>
</microsoft-exchange-response>