Get-OfficeEmail

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Email.EmailDocument OfficeIMO.Email.EmailReadResult

Source

Sources/PSWriteOffice/Cmdlets/Email/GetOfficeEmailCommand.cs:7 Edit on GitHub

Reads a native EML, MSG, or TNEF artifact with bounded diagnostics.

Remarks

Reads a native EML, MSG, or TNEF artifact with bounded diagnostics.

Examples

Authored help example

EXAMPLE 1


Get-OfficeEmail -Path 'C:\Path'

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeEmail [-AsResult] [-Options <EmailReaderOptions>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AsResult SwitchParameter optionalposition: namedpipeline: False: Return the read result with diagnostics and consumed byte count.
Options EmailReaderOptions optionalposition: namedpipeline: False: Optional format detection, compound-file, MIME, attachment, and size limits.
Path String requiredposition: 0pipeline: True (ByValue): Path to an EML, MSG, TNEF, or winmail.dat file.

Outputs

OfficeIMO.Email.EmailDocument OfficeIMO.Email.EmailReadResult