Connect-SMIMEEmailCmdlet
Parameters Output Objects Config Settings
The Connect-SMIMEEmail cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-SMIMEEmail [parameters]
Remarks
This cmdlet allows you to create a persistent connection object to be used with related cmdlets.When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object.
To disconnect call Disconnect-SMIMEEmail.
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| CertPassword | The password to the certificate store. |
| Config | Specifies one or more configuration settings. |
| Credential | The PSCredential object to use for user/password authentication. |
| FirewallHost | Name or IP address of firewall. |
| FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
| FirewallPort | The port of the firewall to which to connect. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| Force | Forces the component to accept the default behavior instead of querying the user. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| Password | The password to use for authentication. |
| Port | The TCP port in the remote host to which to connect. |
| Server | The address of the Server. |
| Timeout | The maximum time allowed for the operation. |
| User | The 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.
| SMIMEEmailConnection | The connection object. |
Config Settings
The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
LogFile Parameter (Connect-SMIMEEmail Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-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
Attachment Parameter (Connect-SMIMEEmail Cmdlet)
The path to any files which are to be attached to the message.
Syntax
Connect-SMIMEEmail -Attachment string[]
Remarks
Default Value
null
BCC Parameter (Connect-SMIMEEmail Cmdlet)
A comma separated list of addresses for blind carbon copies (optional).
Syntax
Connect-SMIMEEmail -BCC string
Remarks
Default Value
""
CC Parameter (Connect-SMIMEEmail Cmdlet)
A comma separated list of addresses for carbon copies (optional).
Syntax
Connect-SMIMEEmail -CC string
Remarks
Default Value
""
CertPassword Parameter (Connect-SMIMEEmail Cmdlet)
The password to the certificate store.
Syntax
Connect-SMIMEEmail -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-SMIMEEmail Cmdlet)
The name of the certificate store for the signing certificate.
Syntax
Connect-SMIMEEmail -CertStore string
Remarks
Default Value
"MY"
CertStoreType Parameter (Connect-SMIMEEmail Cmdlet)
The type of certificate store for the decryption certificate.
Syntax
Connect-SMIMEEmail -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-SMIMEEmail Cmdlet)
The subject of the certificate used for decryption.
Syntax
Connect-SMIMEEmail -CertSubject string
Remarks
Default Value
"*"
Config Parameter (Connect-SMIMEEmail Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-SMIMEEmail -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-SMIMEEmail Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-SMIMEEmail -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
FirewallHost Parameter (Connect-SMIMEEmail Cmdlet)
Name or IP address of firewall.
Syntax
Connect-SMIMEEmail -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-SMIMEEmail Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-SMIMEEmail -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-SMIMEEmail Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-SMIMEEmail -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-SMIMEEmail Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-SMIMEEmail -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-SMIMEEmail Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-SMIMEEmail -FirewallUser string
Remarks
Default Value
""
Force Parameter (Connect-SMIMEEmail Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-SMIMEEmail -Force SwitchParameter
Remarks
Default Value
false
From Parameter (Connect-SMIMEEmail Cmdlet)
The email address of the sender (required).
Syntax
Connect-SMIMEEmail -From string
Remarks
Default Value
""
Parameter Position
4
This is a required parameter.
Importance Parameter (Connect-SMIMEEmail Cmdlet)
Importance of the mail message.
Syntax
Connect-SMIMEEmail -Importance string
Remarks
Default Value
0
LocalIP Parameter (Connect-SMIMEEmail Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-SMIMEEmail -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-SMIMEEmail Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-SMIMEEmail -LogFile string
Remarks
Default Value
""
Message Parameter (Connect-SMIMEEmail Cmdlet)
The full text of the message to be sent (without headers).
Syntax
Connect-SMIMEEmail -Message string
Remarks
Default Value
""
MessageHTML Parameter (Connect-SMIMEEmail Cmdlet)
The full text of the HTML message to be sent (without headers).
Syntax
Connect-SMIMEEmail -MessageHTML string
Remarks
Default Value
""
MessageId Parameter (Connect-SMIMEEmail Cmdlet)
Sets the message Id used by the component.
Syntax
Connect-SMIMEEmail -MessageId string
Remarks
Default Value
"*"
Password Parameter (Connect-SMIMEEmail Cmdlet)
The password to use for authentication.
Syntax
Connect-SMIMEEmail -Password string
Remarks
Default Value
""
Port Parameter (Connect-SMIMEEmail Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Connect-SMIMEEmail -Port int
Remarks
Default Value
25
RecipientCertPassword Parameter (Connect-SMIMEEmail Cmdlet)
The password to the certificate store.
Syntax
Connect-SMIMEEmail -RecipientCertPassword string
Remarks
Default Value
""
RecipientCertStore Parameter (Connect-SMIMEEmail Cmdlet)
The name of the certificate store for the encryption certificate.
Syntax
Connect-SMIMEEmail -RecipientCertStore string
Remarks
Default Value
"MY"
RecipientCertStoreType Parameter (Connect-SMIMEEmail Cmdlet)
The type of certificate store for the signature verification certificate. In most cases PublicKeyFile is used.
Syntax
Connect-SMIMEEmail -RecipientCertStoreType string
Remarks
Default Value
0
RecipientCertSubject Parameter (Connect-SMIMEEmail Cmdlet)
The subject of the recipient's public certificate used for encryption.
Syntax
Connect-SMIMEEmail -RecipientCertSubject string
Remarks
Default Value
"*"
ReplyTo Parameter (Connect-SMIMEEmail Cmdlet)
The email address to which replies should be sent.
Syntax
Connect-SMIMEEmail -ReplyTo string
Remarks
Default Value
""
Server Parameter (Connect-SMIMEEmail Cmdlet)
The address of the Server.
Syntax
Connect-SMIMEEmail -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
SMIME Parameter (Connect-SMIMEEmail Cmdlet)
Specifies the protection level on the outgoing messages.
Syntax
Connect-SMIMEEmail -SMIME string
Remarks
Default Value
0
Subject Parameter (Connect-SMIMEEmail Cmdlet)
The subject of the email.
Syntax
Connect-SMIMEEmail -Subject string
Remarks
Default Value
""
Timeout Parameter (Connect-SMIMEEmail Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-SMIMEEmail -Timeout int
Remarks
Default Value
10
To Parameter (Connect-SMIMEEmail Cmdlet)
A comma separated list of addresses for destinations.
Syntax
Connect-SMIMEEmail -To string
Remarks
Default Value
""
Parameter Position
2
User Parameter (Connect-SMIMEEmail Cmdlet)
The username to use for authentication.
Syntax
Connect-SMIMEEmail -User string
Remarks
Default Value
""
SMIMEEmailConnection Output Object (Connect-SMIMEEmail Cmdlet)
The connection object.
Syntax
Object SMIMEEmailConnection {string CertPassword;
string[] Config;
PSCredential Credential;
string FirewallHost;
string FirewallPassword;
int FirewallPort;
string FirewallType;
string FirewallUser;
SwitchParameter Force;
string LocalIP;
string LogFile;
string Password;
int Port;
string Server;
int Timeout;
string User;
}