Get Message operation


The Get Message process views the details of one or more messages in a queue on a computer that has the Hub Transport server role or the Edge Transport server role installed.

Note

The Get Message operation supports Microsoft Exchange versions 2007, 2010, 2013, 2016, and 2019. 

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

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

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

<microsoft-exchange-request>
   <command>
     <command-name>Get-Message</command-name>
     <format-option/>
     <verbose-logging/>
     <parameters>
       <parameter>
         <name>Identity</name>
         <value>clm-pun-020413\Submission\2765958938634</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>Get-Message -Identity:'clm-pun-020413\Submission\2765958938634'</command>
           <line-count>8</line-count>
           <execution-milliseconds>131493</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 Get-Message -Identity:'clm-pun-020413\Submission\2765958938634' "</line>
           <line index="4">Stdout:</line>
           <line index="5">Identity        FromAddress     Status          Queue           Subject        </line>
           <line index="6">--------        -----------     ------          -----           -------        </line>
           <line index="7">clm-pun-0204... Administrato... Ready           clm-pun-0204... hi             </line>
           <line index="8">Remote application exited with code: 0</line>
         </output>
       </command-output>
     </commands-output>
   </target-output>
 </targets-output>
</microsoft-exchange-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*