Edit

Share via

New-CMEmailProfile

Module:
ConfigurationManager Module

Creates an email profile.

Syntax

Default (Default) 

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

Description

The New-CMEmailProfile cmdlet creates 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: Create an email profile

PS XYZ:\> $Platform = Get-CMSupportedPlatform -Fast -Platform "Windows Phone"
PS XYZ:\> New-CMEmailProfile -AccountName "TestAccount1" -ExchangeHost "TestHost1" -Name "EmailProfile01" -SupportedPlatform $Platform[1] -AccountUserNameType sAMAccountName -AccountDomainActiveDirectory ___domain

The first command gets all supported platform objects for Windows Phone and stores the objects in the $Platform variable.

The second command creates an email named EmailProfile01 using the second supported platform object from $Platform.

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:True
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

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

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

-AllowThirdPartyApplication

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

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

-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

-DoNotUseSsl

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

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 that outgoing email is sent using S/MIME encryption.

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

-ExchangeHost

Specifies the hostname of the Exchange server that hosts Exchange ActiveSync services.

Parameter properties

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

Parameter sets

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

-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

-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 a name for the Exchange ActiveSync email profile.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
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:True
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 that the list of email addresses that have been recently used on the device is synchronized.

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

-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

-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

None

Outputs

IResultObject