Edit

Share via

Set-CMEmailProfile

Module:
ConfigurationManager Module

Sets an email profile.

Syntax

ByValue (Default) 

Set-CMEmailProfile
    -InputObject <IResultObject>
    [-AccountDomainActiveDirectory <String>]
    [-AccountDomainCustom <String>]
    [-AccountName <String>]
    [-AccountUserNameType <String>]
    [-AllowMessageMove <Boolean>]
    [-AllowThirdPartyApplication <Boolean>]
    [-Description <String>]
    [-EmailAddressType <String>]
    [-EnableSmime <Boolean>]
    [-IdentityCertificate <IResultObject>]
    [-MailSyncDays <MailNumberofDaysToSync>]
    [-NewName <String>]
    [-PassThru]
    [-SigningCertificate <IResultObject>]
    [-SupportedPlatform <IResultObject[]>]
    [-SyncContentType <EasProfileSyncContentType>]
    [-SynchronizeRecentlyUsed <Boolean>]
    [-SyncSchedule <Schedule>]
    [-UseSsl <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById 

Set-CMEmailProfile
    -Id <Int32>
    [-AccountDomainActiveDirectory <String>]
    [-AccountDomainCustom <String>]
    [-AccountName <String>]
    [-AccountUserNameType <String>]
    [-AllowMessageMove <Boolean>]
    [-AllowThirdPartyApplication <Boolean>]
    [-Description <String>]
    [-EmailAddressType <String>]
    [-EnableSmime <Boolean>]
    [-IdentityCertificate <IResultObject>]
    [-MailSyncDays <MailNumberofDaysToSync>]
    [-NewName <String>]
    [-PassThru]
    [-SigningCertificate <IResultObject>]
    [-SupportedPlatform <IResultObject[]>]
    [-SyncContentType <EasProfileSyncContentType>]
    [-SynchronizeRecentlyUsed <Boolean>]
    [-SyncSchedule <Schedule>]
    [-UseSsl <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

Set-CMEmailProfile
    -Name <String>
    [-AccountDomainActiveDirectory <String>]
    [-AccountDomainCustom <String>]
    [-AccountName <String>]
    [-AccountUserNameType <String>]
    [-AllowMessageMove <Boolean>]
    [-AllowThirdPartyApplication <Boolean>]
    [-Description <String>]
    [-EmailAddressType <String>]
    [-EnableSmime <Boolean>]
    [-IdentityCertificate <IResultObject>]
    [-MailSyncDays <MailNumberofDaysToSync>]
    [-NewName <String>]
    [-PassThru]
    [-SigningCertificate <IResultObject>]
    [-SupportedPlatform <IResultObject[]>]
    [-SyncContentType <EasProfileSyncContentType>]
    [-SynchronizeRecentlyUsed <Boolean>]
    [-SyncSchedule <Schedule>]
    [-UseSsl <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMEmailProfile cmdlet updates the settings of 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: Update a profile by name

PS XYZ:\> Set-CMEmailProfile -Name "EmailProfile1" -NewName "newEmailProfile1"

This command updates the name of the Exchange ActiveSync email profile from EmailProfile1 to newEmailProfile1.

Example 2: Update a profile by ID

PS XYZ:\> Set-CMEmailProfile -Id 16795654 -NewName "newEmailProfile2"

This command updates the name of the Exchange ActiveSync email profile with the ID of 16795654 to newEmailProfile2.

Example 3: Update a profile as an input object

PS XYZ:\> $EmailProfile = Get-CMEmailProfile -Name "EmailProfile3"
PS XYZ:\> Set-CMEmailProfile -InputObject $EmailProfile -NewName "newEmailProfile3"

The first command gets the Exchange ActiveSync email profile object named EmailProfile3 and stores the object in the $EmailProfile variable.

The second command changes the name of the email profile stored in $EmailProfile to newEmailProfile3.

Example 4: Use the pipeline to update a profile

PS XYZ:\> Get-CMEmailProfile -Name "EmailProfile4" | Set-CMEmailProfile -NewName "newEmailProfile4"

This command gets the Exchange ActiveSync email profile object named EmailProfile4 and uses the pipeline operator to pass the object to Set-CMEmailProfile, which changes the name of the email profile object to newEmailProfile4.

Parameters

-AccountDomainActiveDirectory

Specifies the type of Active Directory account domain. Valid values are:

  • domain
  • ntdomain

Parameter properties

Type:String
Default value:None
Accepted values:domain, ntdomain
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

-AccountDomainCustom

Specifies a custom account domain. This parameter can only be used if the sAMAccountName value is specified for the AccountUserNameType parameter.

Parameter properties

Type:String
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

-AccountName

Specifies the display name for the email account.

Parameter properties

Type:String
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

-AccountUserNameType

Specifies an account user name type. Valid values are:

  • mail
  • sAMAccountName
  • userPrincipalName

Parameter properties

Type:String
Default value:None
Accepted values:mail, sAMAccountName, userPrincipalName
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

-AllowMessageMove

Indicate whether users are allowed to move email messages between different accounts they have configured on their device.

Parameter properties

Type:Boolean
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

-AllowThirdPartyApplication

Indicates whether users are allowed to send email from certain non-default, third-party email applications.

Parameter properties

Type:Boolean
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the Exchange ActiveSync email profile.

Parameter properties

Type:String
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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-EmailAddressType

Specifies an email address type. Valid values are:

  • mail
  • userPrincipalName

Parameter properties

Type:String
Default value:None
Accepted values:mail, userPrincipalName
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

-EnableSmime

Indicates whether outgoing email is sent using S/MIME encryption.

Parameter properties

Type:Boolean
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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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 for an Exchange ActiveSync email profile.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CI_ID, CIId

Parameter sets

ById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IdentityCertificate

Specifies an identity certificate object. To obtain an identity certificate object, use the Get-CMConfigurationPolicy cmdlet.

Parameter properties

Type:IResultObject
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

-InputObject

Specifies an Exchange ActiveSync email profile object. To obtain an email profile object, use the Get-CMEmailProfile function.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-MailSyncDays

Specifies the number of days of email to synchronize. Valid values are:

  • Unlimited
  • OneDay
  • ThreeDays
  • OneWeek
  • TwoWeeks
  • OneMonth

Parameter properties

Type:MailNumberofDaysToSync
Default value:None
Accepted values:Unlimited, OneDay, ThreeDays, OneWeek, TwoWeeks, OneMonth
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

-Name

Specifies the name of an Exchange ActiveSync email profile.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewName

Specifies a new name for an Exchange ActiveSync email profile.

Parameter properties

Type:String
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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-SigningCertificate

Specifies a signing certificate object used for S/MIME signing. To obtain a signing certificate object, use the Get-CMConfigurationPolicy cmdlet.

Parameter properties

Type:IResultObject
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

-SupportedPlatform

Specifies the operating systems on which the email profile will be installed. To obtain a supported platform object, use the Get-CMSupportedPlatform cmdlet.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupportedPlatforms

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncContentType

Specifies a content type to synchronize to devices. Valid values are:

  • None
  • Email
  • Contacts
  • Calendar
  • Tasks
  • Notes
  • All

Parameter properties

Type:EasProfileSyncContentType
Default value:None
Accepted values:None, Email, Contacts, Calendar, Tasks, Notes, All
Supports wildcards:False
DontShow:False
Aliases:SyncContentTypes

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SynchronizeRecentlyUsed

Indicates whether the list of email addresses that have been recently used on the device is synchronized.

Parameter properties

Type:Boolean
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

-SyncSchedule

Specifies the schedule by which devices will synchronize data from the Exchange Server.

  • Manual
  • FifteenMins
  • ThirtyMins
  • SixtyMins
  • AsArrive

Parameter properties

Type:Schedule
Default value:None
Accepted values:Manual, FifteenMins, ThirtyMins, SixtyMins, AsArrive
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

-UseSsl

Indicates whether Secure Sockets Layer (SSL) communication is used when sending emails, receiving emails, and communicating with the Exchange Server.

Parameter properties

Type:Boolean
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
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.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object