Use the Get-NotesMailArchive cmdlet to retrieve the data stored in Notes mail archives.

Get-NotesMailArchive -SourceFileName <String> -DominoMailDomain <String> [-ContentOwner <String>] [-EmailEnd <DateTime>] [-EmailStart <DateTime>] [-ExcludeContacts <SwitchParameter>] [-ExcludeEmail <SwitchParameter>] [-ExcludeSchedule <SwitchParameter>] [-ExcludeTask <SwitchParameter>] [-MaxThreadCount <UInt32>] [-NotesIniPath <String>] [-Quiet <SwitchParameter>] [-SourceCredential <PSCredential>] [-SourceDetail <String>] [-SourceMapping <String>]

Parameters

Parameter

Required

Type

Description

DominoMailDomain

Required

System.String

The DominoMailDomain parameter specifies the Domino Mail Domain that should be associated with the extracted mail items.

SourceFileName

Required

System.String

The SourceFileName parameter is the name of the file to be extracted. This should be provided in one of the following formats:

  • fully qualified path

  • a UNC path

  • a relative path to the current directory

ContentOwner

Optional

System.String

The ContentOwner parameter specifies the e-mail address of the person to whom this content belongs. This parameter is necessary for any content that you expect to move to an Exchange server and must match the proxy address of an existing Active Directory user. ContentOwner should be either a valid Notes ProxyAddress or SMTP Address if the ContentOwner is not correct.

EmailEnd

Optional

System.DateTime

The EmailEnd parameter specifies the end date of the date range for which messages should be included in the migration.

Note: Messages without dates are always included.

EmailStart

Optional

System.DateTime

The EmailStart parameter specifies the start date of the date range for which messages should be included in the migration.

ExcludeContacts

Optional

System.Management.Automation.SwitchParameter

The ExcludeContacts parameter specifies the Contacts information that should be excluded.

ExcludeEmail

Optional

System.Management.Automation.SwitchParameter

The ExcludeEmail parameter specifies the e-mail messages that should be excluded.

ExcludeSchedule

Optional

System.Management.Automation.SwitchParameter

The ExcludeSchedule parameter specifies the schedule information that should be excluded.

ExcludeTask

Optional

System.Management.Automation.SwitchParameter

The ExcludeTask parameter specifies the task information that should be excluded.

MaxThreadCount

Optional

System.UInt32

The MaxThreadCount parameter indicates the maximum number of threads allocated to this task.

NotesIniPath

Optional

System.String

The NotesIniPath parameter specifies the path to local Notes.INI file including filename.

Quiet

Optional

System.Management.Automation.SwitchParameter

The Quiet parameter suppresses feedback during task actions.

SourceCredential

Optional

System.Management.Automation.PSCredential

The SourceCredential parameter specifies the PSH credential object consisting of the Notes ID file and password.

SourceDetail

Optional

System.String

The SourceDetail parameter defines the level of detail retrieved for the application. Levels include:

  • 0 returns basic application information.

  • 1 returns additional information such as forms, fields, and views and matches ACL entries with Active Directory accounts. Identifies mail routing options (@functions and LotusScript).

  • 2 returns additional information such as the code (@functions, LotusScript, etc.) for the application.

SourceMapping

Optional

System.String

The SourceMapping parameter specifies a custom mapfile that defines how the attributes in the object schema will be mapped from the source schema.

Detailed Description

The Get-NotesMailArchive cmdlet retrieves the data stored in Notes mail archives.

To run the Get-NotesMailArchive cmdlet, the account you use must have Read rights to Active Directory directory service and Reader access in each Domino application's access control list (ACL).

Input Types

Return Types

AlienDataObject

Example

The following code sample details how to run the Get-NotesMailArchive cmdlet.

  Copy Code
Get-NotesMailArchive -SourceFileName mjones.nsf -ContentOwner mjones@contoso.com -DominoMailDomain contoso