Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Get-EVFSAComputerSettings
- Get-EVFSAFileServer
- Get-EVFSAFolder
- Get-EVFSASiteSettings
- Get-EVFSAVolume
- New-EVFSAFileServer
- New-EVFSAFolder
- New-EVFSAVolume
- Remove-EVFSAFileServer
- Remove-EVFSAFolder
- Remove-EVFSAVolume
- Set-EVFSAComputerSettings
- Set-EVFSAFileServer
- Set-EVFSAFolder
- Set-EVFSASiteSettings
- Set-EVFSAVolume
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Get-EVIndexSnapshotLocationBackupMode
- Set-EVIndexSnapshotLocationBackupMode
- Clear-EVIndexSnapshotLocationBackupMode
- Get-IndexLocationBackupMode
- Set-IndexLocationBackupMode
- Clear-IndexLocationBackUpMode
- Get-VaultStoreBackupMode
- Set-VaultStoreBackupMode
- Clear-VaultStoreBackupMode
- Set-EVIndexSnapshotLocation
- Get-EVIndexSnapshotLocation
- Remove-EVIndexSnapshotLocation
- New-EVIndexSnapshot
- Get-EVIndexSnapshot
- Remove-EVIndexSnapshot
- Restore-EVIndexSnapshot
- Get-EVIndexSnapshotRepository
- Remove-EVIndexSnapshotRepository
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- Set-EVClassificationVICFIPSMode
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Get-EVIMAPUserSettings
Get-EVIMAPUserSettings gets the IMAP/SMTP client settings for the given user SID.
Get-EVIMAPUserSettings is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Get-EVIMAPUserSettings -SID [-FullFormatUserName [<SwitchParameter>]] [<CommonParameters>]
Table: Get-EVIMAPUserSettings parameters
Parameter | Description |
|---|---|
-SID (required) | The SID (security identifier) of the Active Directory user whose IMAP settings you want to display. |
-FullFormatUserName | If specified, causes the output from the cmdlet to show the full-format version of the user's account name for every archive that the user can access. This full-format version appends an identifier to the user's logon name; for example, EMEA\JohnDoe\1962. If you omit the parameter, the output omits the identifier from the logon name for the user's default IMAP archive, but it shows the identifier for any other archives that the user can access. For more information, see the Setting up IMAP guide. |
Get-EVIMAPUserSettings S-1-5-21-750406912-2207124990-322363385-3682
Returns the IMAP/SMTP server settings for the archives that the user represented by the SID parameter has access to.
Get-EVIMAPUserSettings S-1-5-21-750406912-2207124990-322363385-3682 -FullFormatUserName
Returns the IMAP/SMTP server settings for the archives that the user represented by the SID parameter has access to. The settings for the default IMAP archive shows an identifier as part of the user name. Without the -FullFormatUserName parameter, the identifier is hidden for the default IMAP archive, and only shown for additional archives the user can access. For more information on the identifier in the user name, see the Setting up IMAP guide.
Table: Get-EVIMAPUserSettings properties lists the properties that are available.
Table: Get-EVIMAPUserSettings properties
Name | Type | Description |
|---|---|---|
Archivename | String | The name of the user's archive. |
ArchiveOwner | Boolean | Indicates whether the user is the owner of the archive. Possible values: $true (user owns the archive), $false (user does not own the archive). |
ArchiveType | String | The type of archive. Possible values: "Exchange", "Internet Mail". |
IMAP_Connection_Security | String | The security to use for the IMAP connection. Both STARTTLS and TLS protocols are supported. |
IMAP_Password | String | Specifies which account's password to use when connecting to the archive. |
IMAP_Port | Int32 | The port number to use for the IMAP connection. |
IMAP_Server | String | The IMAP server to which to connect. |
IMAP_UserName | String | The account name to use when connecting to the IMAP server. When the -FullFormatUserName parameter is set, the settings for the default IMAP archive show an identifier as part of the user name. Without the -FullFormatUserName parameter, the identifier is hidden for the default IMAP archive, and only shown for additional archives the user can access. Note: If the default IMAP archive is deleted, no new default archive is selected. The user name for logging onto the remaining archives always includes an identifier. |
ReadyForIMAP | Boolean | Indicates whether the metadata store has been built for the archive. Possible values: $true (the metadata store has been built), $false (the metadata store has not yet been built). Internet mail archives always have a metadata store, so ReadyForIMAP is always true for Internet mail archives. |
SMTP_Connection_Security | String | The type of security to use for the SMTP connection. Both STARTTLS and TLS protocols are supported. |
SMTP_Password | String | Possible values: "SMTP account username" (the SMTP server requires authentication), "Not applicable" (the SMTP server does not require authentication). |
SMTP_Port | Int32 | The port to use for the SMTP connection. |
SMTP_Server | String | The SMTP server to which to connect. |
SMTP_UserName | String | If the SMTP server requires authentication this string contains "SMTP account username". |
WindowsUser | String | The Windows account to use to connect to the IMAP server. |
See Get-EVComputers.
See Get-EVIMAPUsers.