Send-Email Cmdlet
Parameters Output Objects Configuration Settings
The Send-Email cmdlet is used to send Internet mail using the SMTP protocol (the Internet mail standard).
Syntax
Send-Email [parameters]
Remarks
This cmdlet implements a standard SMTP client as specified in RFC 821, and also supports the SSL-enabled equivalent (RFC 2487). To send a message, set the Server, To, Subject, From, and Message parameters.
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.
SSL communications are supported. When communicating with an SSL server, set the SSL parameter. If authentication is required, set the Credential parameter.
The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# Send a simple message send-email -server myserver -from myuser@mydomain -to friend@domain -subject "my subject" -message "message text" -attachment "C:\test.txt" # Send an HMTL message send-email -server myserver -from myuser@mydomain -to friend@domain -subject "New subject" -messagehtml "HTML Message"
Connection Handling
This cmdlet supports persistent connections through the Connection parameter. To establish a new Email connection, use the Connect-Email cmdlet. To close the connection, use the Disconnect-Email 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.
| Connection | An already established connection. |
| LogFile | The location of a file to which debug information is written. |
| Attachment | The path to any files which are to be attached to the message. |
| AuthMechanism | The authentication mechanism to be used when connecting to the mail server. |
| BCC | A comma separated list of addresses for blind carbon copies (optional). |
| CC | A comma separated list of addresses for carbon copies (optional). |
| CertPassword | The password to the certificate store. |
| CertStore | The name of the certificate store for the client certificate. |
| CertStoreType | The type of certificate store for the client certificate. |
| CertSubject | The subject of the certificate used for client authentication. |
| 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 cmdlet to accept the default behavior instead of querying the user. |
| From | The email address of the sender (required). |
| Importance | Importance of the mail message. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| Message | The full text of the message to be sent (without headers). |
| MessageHTML | The full text of the HTML message to be sent (without headers). |
| MessageId | Sets the message Id used by the cmdlet. |
| Password | The password to use for authentication. |
| Port | The TCP port in the remote host to which to connect. |
| ReplyTo | The email address to which replies should be sent. |
| Server | The address of the Server. |
| SSL | Determines how the cmdlet starts SSL negotiation. |
| SSLAccept | The encoded public key of the certificate which is to be trusted explicitly. |
| Subject | The subject of the email. |
| Timeout | The maximum time allowed for the operation. |
| To | A comma separated list of addresses for destinations. |
| 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.
| SMTPDelivery | Object which indicates whether the message was received. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| AllowEmptyTo | If set to True, then the SendTo property is not required. |
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| Charset | When set, the message headers will be encoded using the specified Charset. |
| Hello | The argument for HELO (herald) command to the server (defaults to local host name). |
| KeepQueue | If set to True, queued files are not deleted after a successful send. |
| MaxHeaderLength | Maximum length for headers to avoid line folding (default 80). |
| MessageHeadersString | String representation of RFC822-encoded headers of the message. |
| MessageIdAlgorithm | Determines the algorithm used to hash the random MessageId. |
| OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
| ReturnPath | Sets the Return-Path to be used for sending email. |
| SendRSET | Whether to send RSET command. |
| StopOnToErrors | Instructs the cmdlet to stop sending the message if the server does not acknowledge any of the TOs. |
| StopOnCcErrors | Instructs the cmdlet to stop sending the message if the server does not acknowledge any of the CCs. |
| StopOnBccErrors | Instructs the cmdlet to stop sending the message if the server does not acknowledge any of the BCCs. |
| TransferText | The current portion of the message being sent. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the cmdlet whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the cmdlet binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |