Send-SMIMEEmail Cmdlet

Parameters   Output Objects   Config Settings  

The Send-SMIMEEmail component is used to send Signed and Encrypted Internet mail using the SMTP protocol (the Internet mail standard).

Syntax

Send-SMIMEEmail [parameters]

Remarks

This cmdlet is the SMIME enabled equivalent of SENDEMAIL. In addition to implementing a standard SMTP client as specified in RFC 821, the cmdlet can sign and/or encrypt messages in a PKCS envelope.

To send a message, set the Server, To, Subject, From, and Message parameters.

The CertStoreType, CertStore, CertPassword, and CertSubject parameters specify the signing certificate.

The RecipientCertStoreType, RecipientCertStore RecipientCertPassword, and RecipientCertSubject parameters specify the encryption certificate.

Additional recipients can be set with the CC and BCC parameters. To specify multiple recipients, in the To, CC, and BCC parameters, simply specify the destination email addresses separated by commas.

One or more attachments can be added by setting the Attachment parameter. HTML Messages may be sent by setting the MessageHTML parameter.

The CertStoreType, CertStore, CertPassword, and CertSubject parameters specify the decryption certificate.

The SignerCertStoreType, SignerCertStore SignerCertPassword, and SignerCertSubject parameters specify the recipient's public certificate used for signature verification.

#Decrypt a message Get-SMIMEIMAP -Server mailserver -User test -Password test -view 123 -SMIME Decrypt -CertStore c:\mine.pfx -CertStoreType PFXFile -CertPassword test -CertSubject * #Verify the signature of a message Get-SMIMEIMAP -Server mailserver -User test -Password test -view 124 -SMIME Verify -SignerCertStoreType PublicKeyFile -SignerCertStore c:\sender.public.cer -SignerCertSubject * #Decrypt and Verify the signature Get-SMIMEIMAP -Server mailserver -User test -Password test -view 125 -SMIME DecryptAndVerify -CertStore c:\mine.pfx -CertStoreType pfxfile -CertPassword test -CertSubject * -SignerCertStore c:\sender.public.cer -SignerCertSubject * -SignerCertStoreType PublicKeyFile

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new SMIMEEmail connection, use the Connect-SMIMEEmail cmdlet. To close the connection, use the Disconnect-SMIMEEmail cmdlet.

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

ConnectionAn already established connection.
LogFileThe location of a file to which debug information is written.
AttachmentThe path to any files which are to be attached to the message.
BCCA comma separated list of addresses for blind carbon copies (optional).
CCA comma separated list of addresses for carbon copies (optional).
CertPasswordThe password to the certificate store.
CertStoreThe name of the certificate store for the signing certificate.
CertStoreTypeThe type of certificate store for the decryption certificate.
CertSubjectThe subject of the certificate used for decryption.
ConfigSpecifies one or more configuration settings.
CredentialThe PSCredential object to use for user/password authentication.
FirewallHostName or IP address of firewall.
FirewallPasswordA password if authentication is to be used when connecting through the firewall.
FirewallPortThe port of the firewall to which to connect.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
ForceForces the component to accept the default behavior instead of querying the user.
FromThe email address of the sender (required).
ImportanceImportance of the mail message.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
MessageThe full text of the message to be sent (without headers).
MessageHTMLThe full text of the HTML message to be sent (without headers).
MessageIdSets the message Id used by the component.
PasswordThe password to use for authentication.
PortThe TCP port in the remote host to which to connect.
RecipientCertPasswordThe password to the certificate store.
RecipientCertStoreThe name of the certificate store for the encryption certificate.
RecipientCertStoreTypeThe type of certificate store for the signature verification certificate. In most cases PublicKeyFile is used.
RecipientCertSubjectThe subject of the recipient's public certificate used for encryption.
ReplyToThe email address to which replies should be sent.
ServerThe address of the Server.
SMIMESpecifies the protection level on the outgoing messages.
SubjectThe subject of the email.
TimeoutThe maximum time allowed for the operation.
ToA comma separated list of addresses for destinations.
UserThe username to use for authentication.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

Config Settings


The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Send-SMIMEEmail Cmdlet)

The location of a file to which debug information is written.

Syntax

Send-SMIMEEmail -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

Connection Parameter (Send-SMIMEEmail Cmdlet)

An existing SMIMEEmail connection.

Syntax

Send-SMIMEEmail -Connection SMIMEEmailConnection

Remarks

Represents an existing, persistent SMIMEEmail connection to be used. After this cmdlet executes, the connection will remain opened to be used in an another call. New connections can be established using the Connect-SMIMEEmail cmdlet and closed using the Disconnect-SMIMEEmail cmdlet.

Default Value

null

Attachment Property (Send-SMIMEEmail Cmdlet)

The path to any files which are to be attached to the message.

Syntax

Send-SMIMEEmail -Attachment string[]

Remarks

Set Attachment to the path of a file on your system that you would like to send as an attachment with your message. The cmdlet will open the file and encode its contents in MIME format.

Default Value

null

BCC Property (Send-SMIMEEmail Cmdlet)

A comma separated list of addresses for blind carbon copies (optional).

Syntax

Send-SMIMEEmail -BCC string

Remarks

BCC specifies a comma separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.

Default Value

""

CC Property (Send-SMIMEEmail Cmdlet)

A comma separated list of addresses for carbon copies (optional).

Syntax

Send-SMIMEEmail -CC string

Remarks

CC specifies a comma separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of BCC).

Default Value

""

CertPassword Property (Send-SMIMEEmail Cmdlet)

The password to the certificate store.

Syntax

Send-SMIMEEmail -CertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

Parameter Alias

CertificatePassword

CertStore Property (Send-SMIMEEmail Cmdlet)

The name of the certificate store for the signing certificate.

Syntax

Send-SMIMEEmail -CertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify the certificate used for signing the message. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during processing. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

CertStoreType Property (Send-SMIMEEmail Cmdlet)

The type of certificate store for the decryption certificate.

Syntax

Send-SMIMEEmail -CertStoreType string

Remarks

This parameter can take one of the following values:

User (default)This specifies that the certificate store is owned by the current user (these are the user's registry certificate stores such as MY, CA, etc.).
MachineThe certificate store is a machine store.
PFXFileThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBlobThe certificate store is a string (base64 encoded) representing a certificate store in PFX (PKCS12) format. You should use this option if storing a pfx file's content in a shell variable.
PEMKeyFileThe certificate store is the name of a file that contains a PEM encoded certificate and private key.
PEMKeyBlobThe certificate store is a string that contains a PEM encoded certificate and private key.
P7BFileThe certificate store is the name of a file that contains P7B encoded certificates.
SSHPublicKeyFileThe certificate store is the name of a file that contains an SSH-style public key.
PPKFileThe certificate store is the name of a file that contains a PPK (PuTTY Private Key).
PPKBlobThe certificate store is a string (binary) that contains a PPK (PuTTY Private Key).

Default Value

0

CertSubject Property (Send-SMIMEEmail Cmdlet)

The subject of the certificate used for decryption.

Syntax

Send-SMIMEEmail -CertSubject string

Remarks

During the signing phase of processing, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a private key for that certificate, it is used to sign the outgoing message.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

Config Property (Send-SMIMEEmail Cmdlet)

Specifies one or more configuration settings.

Syntax

Send-SMIMEEmail -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

Credential Property (Send-SMIMEEmail Cmdlet)

The PSCredential object to use for user/password authentication.

Syntax

Send-SMIMEEmail -Credential PSCredential

Remarks

Every cmdlet that supports user authentication will expose a Credential parameter. A PSCredential object should be specified for this parameter. Alternatively, the User and Password parameters can be set to represent the credential information.

If the cmdlet supports client key authentication it uses the password field of this object for the certificate's password. This setting is enabled by using public key authentication. Note: Due to security reasons, it is recommended that you use the Credential parameter rather than User and Password to specify the authentication information.

Default Value

null

Parameter Position

1

Parameter Alias

auth

FirewallHost Property (Send-SMIMEEmail Cmdlet)

Name or IP address of firewall.

Syntax

Send-SMIMEEmail -FirewallHost string

Remarks

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost parameter is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

FirewallPassword Property (Send-SMIMEEmail Cmdlet)

A password if authentication is to be used when connecting through the firewall.

Syntax

Send-SMIMEEmail -FirewallPassword string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

FirewallPort Property (Send-SMIMEEmail Cmdlet)

The port of the firewall to which to connect.

Syntax

Send-SMIMEEmail -FirewallPort int

Remarks

The TCP port for the FirewallHost. See the description of the FirewallHost parameter for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType parameter for details. Setting this parameter will overwrite the default settings for the firewall port as specified by FirewallType.

Default Value

0

FirewallType Property (Send-SMIMEEmail Cmdlet)

Determines the type of firewall to connect through.

Syntax

Send-SMIMEEmail -FirewallType string

Remarks

The applicable values are the following:

None No firewall (default setting).
TunnelConnect through a tunneling proxy. FirewallPort is set to 80.
SOCKS4Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
SOCKS5Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

Default Value

0

FirewallUser Property (Send-SMIMEEmail Cmdlet)

A user name if authentication is to be used connecting through a firewall.

Syntax

Send-SMIMEEmail -FirewallUser string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

Force Property (Send-SMIMEEmail Cmdlet)

Forces the component to accept the default behavior instead of querying the user.

Syntax

Send-SMIMEEmail -Force SwitchParameter

Remarks

The Force parameter is especially useful in a script environment where user interaction is not an option. Certain cmdlets that are SSH and SSL based will query the user if the security credentials of the certificate presented by the server are not met. Setting this parameter will force the cmdlet to accept the certificate of the server unconditionally.

Default Value

false

From Property (Send-SMIMEEmail Cmdlet)

The email address of the sender (required).

Syntax

Send-SMIMEEmail -From string

Remarks

From is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

Default Value

""

Parameter Position

4

This is a required parameter.

Importance Property (Send-SMIMEEmail Cmdlet)

Importance of the mail message.

Syntax

Send-SMIMEEmail -Importance string

Remarks

When set, an Importance header will added to the message. Importance is an indication to the recipient(s) about how important the message is. The possible values are High, Normal, and Low.

Default Value

0

LocalIP Property (Send-SMIMEEmail Cmdlet)

The IP address of the local interface to use.

Syntax

Send-SMIMEEmail -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Send-SMIMEEmail Cmdlet)

The location of a file to which debug information is written.

Syntax

Send-SMIMEEmail -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Message Property (Send-SMIMEEmail Cmdlet)

The full text of the message to be sent (without headers).

Syntax

Send-SMIMEEmail -Message string

Remarks

Message should contain the full text of the message.

It is advisable that the text contained in this parameter be a collection of lines with lengths less than or equal to 80 bytes separated by CR LF. The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.

The cmdlet automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

Default Value

""

MessageHTML Property (Send-SMIMEEmail Cmdlet)

The full text of the HTML message to be sent (without headers).

Syntax

Send-SMIMEEmail -MessageHTML string

Remarks

MessageHTML should contain the full text of the message.

If both MessageHTML and Message are set, the cmdlet will create a multipart alternative MIME message with both these properties.

Default Value

""

MessageId Property (Send-SMIMEEmail Cmdlet)

Sets the message Id used by the component.

Syntax

Send-SMIMEEmail -MessageId string

Remarks

If set to "*" (default value) the cmdlet will generate a random message Id.

Default Value

"*"

Password Property (Send-SMIMEEmail Cmdlet)

The password to use for authentication.

Syntax

Send-SMIMEEmail -Password string

Remarks

Every time User, or Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Port Property (Send-SMIMEEmail Cmdlet)

The TCP port in the remote host to which to connect.

Syntax

Send-SMIMEEmail -Port int

Remarks

Port specifies a service port on the remote host to which to connect.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

Default Value

25

RecipientCertPassword Property (Send-SMIMEEmail Cmdlet)

The password to the certificate store.

Syntax

Send-SMIMEEmail -RecipientCertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

RecipientCertStore Property (Send-SMIMEEmail Cmdlet)

The name of the certificate store for the encryption certificate.

Syntax

Send-SMIMEEmail -RecipientCertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify the public certificate used for encrypting. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during processing. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

RecipientCertStoreType Property (Send-SMIMEEmail Cmdlet)

The type of certificate store for the signature verification certificate. In most cases PublicKeyFile is used.

Syntax

Send-SMIMEEmail -RecipientCertStoreType string

Remarks

This parameter can take one of the following values:

User (default)This specifies that the certificate store is owned by the current user (these are the user's registry certificate stores such as MY, CA, etc.).
MachineThe certificate store is a machine store.
PFXFileThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBlobThe certificate store is a string (base64 encoded) representing a certificate store in PFX (PKCS12) format. You should use this option if storing a pfx file's content in a shell variable.
PEMKeyFileThe certificate store is the name of a file that contains a PEM encoded certificate and private key.
PEMKeyBlobThe certificate store is a string that contains a PEM encoded certificate and private key.
P7BFileThe certificate store is the name of a file that contains P7B encoded certificates.
SSHPublicKeyFileThe certificate store is the name of a file that contains an SSH-style public key.
PPKFileThe certificate store is the name of a file that contains a PPK (PuTTY Private Key).
PPKBlobThe certificate store is a string (binary) that contains a PPK (PuTTY Private Key).

Default Value

0

RecipientCertSubject Property (Send-SMIMEEmail Cmdlet)

The subject of the recipient's public certificate used for encryption.

Syntax

Send-SMIMEEmail -RecipientCertSubject string

Remarks

During the encrypting phase of processing, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a match, it is used to encrypt the outgoing message.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

ReplyTo Property (Send-SMIMEEmail Cmdlet)

The email address to which replies should be sent.

Syntax

Send-SMIMEEmail -ReplyTo string

Remarks

ReplyTo is used to create a Reply-To SMTP header. If this header is present, replies to this email will be sent to the Reply-To address rather than the From address. This property is not required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

Default Value

""

Server Property (Send-SMIMEEmail Cmdlet)

The address of the Server.

Syntax

Send-SMIMEEmail -Server string

Remarks

The cmdlet requires a server address to be provided. Either an IP address or the server host name can be provided.

Default Value

""

Parameter Position

0

This is a required parameter.

SMIME Property (Send-SMIMEEmail Cmdlet)

Specifies the protection level on the outgoing messages.

Syntax

Send-SMIMEEmail -SMIME string

Remarks

This parameter specifies the protection level of outgoing message. The cmdlet uses this value to determine what operations are performed on the message. Possible values are:

None (default)No SMIME processing is done and the message is treated as a normal message.
SignThe message is encrypted.
EncryptThe message is signed.
SignAndEncryptThe message is signed and encrypted.

Default Value

0

Subject Property (Send-SMIMEEmail Cmdlet)

The subject of the email.

Syntax

Send-SMIMEEmail -Subject string

Remarks

The string in Subject is sent with a Subject SMTP header to the mail recipient.

Default Value

""

Timeout Property (Send-SMIMEEmail Cmdlet)

The maximum time allowed for the operation.

Syntax

Send-SMIMEEmail -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

To Property (Send-SMIMEEmail Cmdlet)

A comma separated list of addresses for destinations.

Syntax

Send-SMIMEEmail -To string

Remarks

To specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

Default Value

""

Parameter Position

2

User Property (Send-SMIMEEmail Cmdlet)

The username to use for authentication.

Syntax

Send-SMIMEEmail -User string

Remarks

Every time User and Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Config Settings (Send-SMIMEEmail Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all cmdlets used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.