Compartir a través de

Send-MailMessage

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Envía un mensaje de correo electrónico.

Syntax

Send-MailMessage
    [-To] <string[]>
    [-Subject] <string>
    [[-Body] <string>]
    [[-SmtpServer] <string>]
    -From <string>
    [-Attachments <string[]>]
    [-Bcc <string[]>]
    [-BodyAsHtml]
    [-Encoding <Encoding>]
    [-Cc <string[]>]
    [-DeliveryNotificationOption <DeliveryNotificationOptions>]
    [-Priority <MailPriority>]
    [-Credential <pscredential>]
    [-UseSsl]
    [-Port <int>]
    [<CommonParameters>]

Description

El Send-MailMessage cmdlet envía un mensaje de correo electrónico desde PowerShell.

Debe especificar un servidor simple de protocolo de transferencia de correo (SMTP) o se produce un error en el Send-MailMessage comando. Use el parámetro SmtpServer o establezca la $PSEmailServer variable en un servidor SMTP válido. El valor asignado a $PSEmailServer es la configuración de SMTP predeterminada para PowerShell. Para obtener más información, consulte about_Preference_Variables.

Ejemplos

Ejemplo 1: Enviar un correo electrónico de una persona a otra

En este ejemplo se envía un mensaje de correo electrónico de una persona a otra.

Los parámetros From, To y Subject son necesarios para Send-MailMessage. En este ejemplo se usa la variable predeterminada $PSEmailServer para el servidor SMTP, por lo que no se necesita el parámetro SmtpServer .

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>' -Subject 'Test mail'

El Send-MailMessage cmdlet usa el parámetro From para especificar el remitente del mensaje. El parámetro To especifica el destinatario del mensaje. El parámetro Subject usa la cadena de texto Test mail como mensaje porque no se incluye el parámetro Body opcional.

Ejemplo 2: Envío de datos adjuntos

En este ejemplo se envía un mensaje de correo electrónico con datos adjuntos.

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>', 'User03 <user03@fabrikam.com>' -Subject 'Sending the Attachment' -Body "Forgot to send the attachment. Sending now." -Attachments .\data.csv -Priority High -DeliveryNotificationOption OnSuccess, OnFailure -SmtpServer 'smtp.fabrikam.com'

El Send-MailMessage cmdlet usa el parámetro From para especificar el remitente del mensaje. El parámetro To especifica los destinatarios del mensaje. El parámetro Subject describe el contenido del mensaje. El parámetro Body es el contenido del mensaje.

El parámetro Attachments especifica el archivo del directorio actual adjunto al mensaje de correo electrónico. El parámetro Priority establece el mensaje en Prioridad alta . El parámetro -DeliveryNotificationOption especifica dos valores, OnSuccess y OnFailure. El remitente recibirá notificaciones por correo electrónico para confirmar que la entrega del mensaje se ha realizado correctamente o no. El parámetro SmtpServer establece el servidor SMTP en smtp.fabrikam.com.

Ejemplo 3: Enviar correo electrónico a una lista de distribución de correo

En este ejemplo se envía un mensaje de correo electrónico a una lista de distribución de correo.

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'ITGroup <itdept@fabrikam.com>' -Cc 'User02 <user02@fabrikam.com>' -Bcc 'ITMgr <itmgr@fabrikam.com>' -Subject "Don't forget today's meeting!" -Credential domain01\admin01 -UseSsl

El Send-MailMessage cmdlet usa el parámetro From para especificar el remitente del mensaje. El parámetro To especifica los destinatarios del mensaje. El parámetro Cc envía una copia del mensaje al destinatario especificado. El parámetro CCO envía una copia ciega del mensaje. Una copia ciega es una dirección de correo electrónico que está oculta a los demás destinatarios. El parámetro Subject es el mensaje porque no se incluye el parámetro Body opcional.

El parámetro Credential especifica que las credenciales de un administrador de dominio se usan para enviar el mensaje. El parámetro UseSsl especifica que Capa de sockets seguros (SSL) crea una conexión segura.

Parámetros

-Attachments

Especifica la ruta de acceso y los nombres de archivo de los archivos que se van a adjuntar al mensaje de correo electrónico. Puede usar este parámetro o canalizar las rutas de acceso y los nombres de archivo a Send-MailMessage.

Type:String[]
Aliases:PsPath
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Bcc

Especifica las direcciones de correo electrónico que reciben una copia del correo, pero no se muestran como destinatarios del mensaje. Escriba los nombres (opcional) y la dirección de correo electrónico, como Name <someone@fabrikam.com>.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Body

Especifica el contenido del mensaje de correo electrónico.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyAsHtml

Especifica que el valor del parámetro Body contiene HTML.

Type:SwitchParameter
Aliases:BAH
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Cc

Especifica las direcciones de correo electrónico a las que se envía una copia de carbono (CC) del mensaje de correo electrónico. Escriba los nombres (opcional) y la dirección de correo electrónico, como Name <someone@fabrikam.com>.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Especifica una cuenta de usuario con permiso para realizar esta acción. El valor predeterminado es el usuario actual.

Escriba un nombre de usuario, como User01 o Domain01\User01. O bien, escriba un objeto PSCredential , como uno del Get-Credential cmdlet .

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryNotificationOption

Especifica las opciones de notificación de entrega para el mensaje de correo electrónico. Se pueden especificar varios valores. None es el valor predeterminado. El alias de este parámetro es DNO.

Las notificaciones de entrega se envían a la dirección en el parámetro From .

Los valores aceptables para este parámetro son los siguientes:

  • Ninguno: sin notificación.
  • OnSuccess: notifique si la entrega se realiza correctamente.
  • OnFailure: notifique si la entrega no se realiza correctamente.
  • Retraso: notifique si la entrega se retrasa.
  • Nunca: No notifique nunca.
Type:DeliveryNotificationOptions
Aliases:DNO
Accepted values:None, OnSuccess, OnFailure, Delay, Never
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

Especifica el tipo de codificación del archivo de destino. El valor predeterminado es Default.

Los valores aceptables para este parámetro son los siguientes:

  • ASCII Usa el juego de caracteres ASCII (7 bits).
  • BigEndianUnicode Usa UTF-16 con el orden de bytes big-endian.
  • Predeterminado Usa la codificación que corresponde a la página de códigos activa del sistema (normalmente ANSI).
  • OEM Usa la codificación que corresponde a la página de códigos oem actual del sistema.
  • Unicode Usa UTF-16 con el orden de bytes little-endian.
  • UTF7 Usa UTF-7.
  • UTF8 Usa UTF-8.
  • UTF32 Usa UTF-32 con el orden de bytes little-endian.
Type:Encoding
Aliases:BE
Accepted values:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Position:Named
Default value:Default
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-From

Se requiere el parámetro From . Este parámetro especifica la dirección de correo electrónico del remitente. Escriba un nombre (opcional) y una dirección de correo electrónico, como Name <someone@fabrikam.com>.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Port

Especifica un puerto alternativo en el servidor SMTP. El valor predeterminado es 25, que es el puerto SMTP predeterminado.

Type:Int32
Position:Named
Default value:25
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Priority

Especifica la prioridad del mensaje de correo electrónico. El valor predeterminado es Normal. Los valores aceptables para este parámetro son Normal, High y Low.

Type:MailPriority
Accepted values:Normal, High, Low
Position:Named
Default value:Normal
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SmtpServer

Especifica el nombre del servidor SMTP que envía el mensaje de correo electrónico.

El valor predeterminado es el valor de la variable de $PSEmailServer preferencia. Si no se establece la variable de preferencia y no se usa este parámetro, se produce un error en el Send-MailMessage comando.

Type:String
Aliases:ComputerName
Position:3
Default value:$PSEmailServer
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Subject

Se requiere el parámetro Subject . Este parámetro especifica el asunto del mensaje de correo electrónico.

Type:String
Aliases:sub
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-To

Se requiere el parámetro To . Este parámetro especifica la dirección de correo electrónico del destinatario. Si hay varios destinatarios, separe sus direcciones con una coma (,). Escriba los nombres (opcional) y la dirección de correo electrónico, como Name <someone@fabrikam.com>.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UseSsl

El protocolo Capa de sockets seguros (SSL) se usa para establecer una conexión segura al equipo remoto para enviar correo. De forma predeterminada, no se usa SSL.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Puede canalizar la ruta de acceso y los nombres de archivo de los datos adjuntos a Send-MailMessage.

Salidas

None

Este cmdlet no genera ningún resultado.