How to pipe Email Data to CSV in PowerShell

The CData Cmdlets Module for Email is a standard PowerShell module offering straightforward integration with Email. Below, you will find examples of using our Email Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Email Data

The User and Password properties, under the Authentication section, must be set to valid credentials. The Server must be specified to retrieve emails and the SMTPServer must be specified to send emails.

$conn = Connect-Email  -User "$User" -Password "$Password" -Server "$Server" -Port "$Port" -SMTP Server "$SMTP Server" -SMTP Port "$SMTP Port" -SSL Mode "$SSL Mode" -Protocol "$Protocol" -Mailbox "$Mailbox"

Selecting Data

Follow the steps below to retrieve data from the Mailboxes table and pipe the result into to a CSV file:

Select-Email -Connection $conn -Table Mailboxes | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMailboxesData.csv -NoTypeInformation

You will notice that we piped the results from Select-Email into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-Email -Connection $conn -Table Mailboxes -Where "Mailbox = Spam" | Remove-Email

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Email, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyMailboxesUpdates.csv | %{
  $record = Select-Email -Connection $Email -Table Mailboxes -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Email -Connection $email -Table Mailboxes -Columns ("Mailbox","RecentMessagesCount") -Values ($_.Mailbox, $_.RecentMessagesCount) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Email -Connection $email -Table Mailboxes -Columns ("Mailbox","RecentMessagesCount") -Values ($_.Mailbox, $_.RecentMessagesCount)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!