AWS.Tools.WorkMailMessageFlow

4.0.2.0

AWS.Tools.WorkMailMessageFlow.dll-Help.xml

                                <helpItems schema="maml">

  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <details>

      <name>Get-WMMFRawMessageContent</name>

      <description>

        <para>Calls the Amazon WorkMail Message Flow GetRawMessageContent API operation.</para>

      </description>

      <verb>Get</verb>

      <noun>WMMFRawMessageContent</noun>

      <copyright>

        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>

      </copyright>

    </details>

    <description>

      <para>Retrieves the raw content of an in-transit email message, in MIME format. </para>

    </description>

    <syntax>

      <syntaxItem>

        <name>Get-WMMFRawMessageContent</name>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

          <name>MessageId</name>

          <description>

            <para>The identifier of the email message to retrieve. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Select</name>

          <description>

            <para>Use the -Select parameter to control the cmdlet output. The default value is 'MessageContent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse). Specifying the name of a property of type Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>PassThru</name>

          <description>

            <para>Changes the cmdlet behavior to return the value passed to the MessageId parameter. The -PassThru parameter is deprecated, use -Select '^MessageId' instead. This parameter will be removed in a future version. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>EndpointUrl</name>

          <description>

            <para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Region</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Object</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>AccessKey</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>SecretKey</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>SessionToken</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>ProfileName</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>ProfileLocation</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named">

          <name>Credential</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named">

          <name>NetworkCredential</name>

          <description>

            <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue>

        </parameter>

      </syntaxItem>

    </syntax>

    <parameters>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>AccessKey</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named">

        <name>Credential</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue>

        <type>

          <name>Amazon.Runtime.AWSCredentials</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>EndpointUrl</name>

        <description>

          <para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

        <name>MessageId</name>

        <description>

          <para>The identifier of the email message to retrieve. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named">

        <name>NetworkCredential</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue>

        <type>

          <name>System.Management.Automation.PSCredential</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>PassThru</name>

        <description>

          <para>Changes the cmdlet behavior to return the value passed to the MessageId parameter. The -PassThru parameter is deprecated, use -Select '^MessageId' instead. This parameter will be removed in a future version. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>ProfileLocation</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>ProfileName</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Region</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Object</parameterValue>

        <type>

          <name>System.Object</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>SecretKey</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Select</name>

        <description>

          <para>Use the -Select parameter to control the cmdlet output. The default value is 'MessageContent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse). Specifying the name of a property of type Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>SessionToken</name>

        <description>

          <para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

    </parameters>

    <returnValues>

      <returnValue>

        <type>

          <name>System.IO.Stream or Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse</name>

          <uri />

          <description />

        </type>

        <description>

          <para>This cmdlet returns a System.IO.Stream object.

The service call response (type Amazon.WorkMailMessageFlow.Model.GetRawMessageContentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>

        </description>

      </returnValue>

    </returnValues>

    <relatedLinks>

      <navigationLink>

        <linkText>Online version:</linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WMMFRawMessageContent.html&amp;tocid=Get-WMMFRawMessageContent</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Common credential and region parameters: </linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>

      </navigationLink>

    </relatedLinks>

  </command>

</helpItems>