Cmdlets for Email

Build 23.0.8839

Getting Started

Connecting to IMAP

Establishing a Connection shows how to authenticate to IMAP and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for Email provides a familiar way to interact with IMAP from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with IMAP using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-Email cmdlet. You can then pass the EmailConnection object returned to other cmdlets for accessing data:

  • Select-Email
  • Add-Email
  • Update-Email
  • Remove-Email

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-Email cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

IMAP Version Support

The cmdlet is a standard IMAP and POP client, as well as an SMTP server. The cmdlet models your account's mailboxes as bidirectional tables, enabling you to send, move, delete, and search messages through standard SQL.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839