Set Mail User operation

The Set Mail User process modifies the mail-related attributes of an existing user in the Active Directory directory service. 

Note

The Set Mail User operation supports Microsoft Exchange versions 2007, 2010, 2013, and 2016.

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

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

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

<microsoft-exchange-request>
   <command>
     <command-name>Set-MailUser</command-name>
     <format-option/>
     <verbose-logging/>
     <parameters>
       <parameter>
         <name>Identity</name>
         <value>user1233</value>
       </parameter>
       <parameter>
         <name>Alias</name>
         <value>kaukur</value>
       </parameter>
       <parameter>
         <name>EmailAddressPolicyEnabled</name>
         <value>$false</value>
       </parameter>
       <parameter>
         <name>HiddenFromAddressListsEnabled</name>
         <value>$false</value>
       </parameter>
       <parameter>
         <name>MaxReceiveSize</name>
         <value>10MB</value>
       </parameter>
       <parameter>
         <name>MaxSendSize</name>
         <value>20MB</value>
       </parameter>
       <parameter>
         <name>MessageBodyFormat</name>
         <value>Text</value>
       </parameter>
       <parameter>
         <name>MessageFormat</name>
         <value>Text</value>
       </parameter>
       <parameter>
         <name>Name</name>
         <value>k kumar</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>Set-MailUser -Identity:user1233 -Alias:kaukur -EmailAddressPolicyEnabled:$false -HiddenFromAddressListsEnabled:$false -MaxReceiveSize:10MB -MaxSendSize:20MB -MessageBodyFormat:Text -MessageFormat:Text -Name:'k kumar' -confirm:$false</command>
           <line-count>5</line-count>
           <execution-milliseconds>47162</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 Set-MailUser -Identity:user1233 -Alias:kaukur -EmailAddressPolicyEnabled:$false -HiddenFromAddressListsEnabled:$false -MaxReceiveSize:10MB -MaxSendSize:20MB -MessageBodyFormat:Text -MessageFormat:Text -Name:'k kumar' -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>

 

 

 

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