Get-CMEmailProfile
Gets an email profile.
Syntax
ByValue (Default)
Get-CMEmailProfile
[-Fast]
[<CommonParameters>]
ById
Get-CMEmailProfile
[-Id] <Int32>
[-Fast]
[<CommonParameters>]
ByName
Get-CMEmailProfile
[-Name] <String>
[-Fast]
[<CommonParameters>]
Description
The Get-CMEmailProfile function gets an Exchange ActiveSync email profile.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Get an email profile by name
PS XYZ:\> Get-CMEmailProfile -Name "EmailProfile1"
This command gets the Exchange ActiveSync email profile with the name EmailProfile1.
Example 2: Get an email profile by ID
PS XYZ:\> Get-CMEmailProfile -ID 16795653
This command gets the Exchange ActiveSync email profile with the CI_ID of 16795653.
Example 3: Get all email profiles
PS XYZ:\> Get-CMEmailProfile -Fast
This command gets all Exchange ActiveSync email profiles. The command does not return lazy properties.
Parameters
-Fast
Indicates that the cmdlet does not automatically refresh lazy properties.
Lazy properties contain values that are relatively inefficient to retrieve which can cause additional network traffic and decrease cmdlet performance. If lazy properties are not used, this parameter should be specified.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies the CI_ID of an email profile.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CIId, CI_ID |
Parameter sets
ById
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of an email profile.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
ByName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.