Logo

Documentation home for Transend tools

Export-GWMailboxes

SYNOPSIS

Exports all mailboxes from a GroupWise tenant.

SYNTAX

Action

Export-GWMailboxes -ConfigNode <String> [-Format <String>] [<CommonParameters>]

Help

Export-GWMailboxes [-ShowPrereqs] [<CommonParameters>]

DESCRIPTION

Use the Export-GWMailboxes cmdlet to export all mailboxes from a GroupWise tenant.

Note that the export includes all mailboxes. If you only want shared mailboxes, use Export-GWSharedMailboxes instead.

EXAMPLES

Example 1

Description

This example exports all mailboxes from a GroupWise tenant. The exported data is formatted as CSV and saved to the file mailboxes.csv.

Tenant configuration

Tenant Direction APIs
GroupWise Source REST API, SOAP API

TMCTools

@{
  Source = @{
    GWServer         = 'groupwise.source.org'
    GWTrustedAppName = 'TMCTools'
    GWTrustedAppKey  = '8C7A44010D390000B6E3E738F0DECCC78C7A44020D390000A21E3E559C55529B'
  }
}

Export-GWMailboxes -ConfigNode Source -Format Csv >'mailboxes.csv'

PARAMETERS

-ConfigNode

The TMCTools.psd1 configuration node to use.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Format

The output type for exported data.

Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

Required: False
Position: Named
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object[]

NOTES

  • Additional TMCTools.psd1 configurations may be required for some environments.

    • Use GWInsecure = $true to disable certificate checking with the GroupWise server (default: $false).

    • Use GWRestPort to configure the REST API port (default: 9710).

    • Use GWRestTlsProtocol to configure the TLS protocol for the REST API. Available options are Default (default), Tls, Tls11, Tls12, and Tls13.

    • Use GWSoapPort to configure the REST API port (default: 7191).

    • Use GWSoapTlsProtocol to configure the TLS protocol for the SOAP API. Available options are Default (default), Tls, Tls11, Tls12, and Tls13.

TMCTools configuration options