Compartilhar via

Send-MailMessage

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Envia uma mensagem de email.

Sintaxe

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

O cmdlet Send-MailMessage envia uma mensagem de email de dentro do PowerShell.

Você deve especificar um servidor SMTP (Simple Mail Transfer Protocol) ou o comando Send-MailMessage falhar. Use o parâmetro SmtpServer ou defina a variável $PSEmailServer como um servidor SMTP válido. O valor atribuído a $PSEmailServer é a configuração SMTP padrão para o PowerShell. Para obter mais informações, consulte about_Preference_Variables.

Exemplos

Exemplo 1: enviar um email de uma pessoa para outra pessoa

Este exemplo envia uma mensagem de email de uma pessoa para outra pessoa.

Os parâmetros From, Toe Subject são exigidos por Send-MailMessage. Este exemplo usa a variável de padrão para o servidor SMTP, portanto, o parâmetro SmtpServer não é necessário.

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

O cmdlet Send-MailMessage usa o parâmetro From para especificar o remetente da mensagem. O parâmetro To especifica o destinatário da mensagem. O parâmetro Subject usa a cadeia de caracteres de texto de email de teste como a mensagem porque o parâmetro Body opcional não está incluído.

Exemplo 2: Enviar um anexo

Este exemplo envia uma mensagem de email com um anexo.

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'

O cmdlet Send-MailMessage usa o parâmetro From para especificar o remetente da mensagem. O parâmetro To especifica os destinatários da mensagem. O parâmetro Subject descreve o conteúdo da mensagem. O parâmetro Body é o conteúdo da mensagem.

O parâmetro Attachments especifica o arquivo no diretório atual anexado à mensagem de email. O parâmetro Priority define a mensagem como prioridade de alta. O parâmetro -DeliveryNotificationOption especifica dois valores, OnSuccess e OnFailure. O remetente receberá notificações por email para confirmar o êxito ou a falha da entrega da mensagem. O parâmetro SmtpServer define o servidor SMTP como smtp.fabrikam.com.

Exemplo 3: Enviar email para uma lista de endereçamento

Este exemplo envia uma mensagem de email para uma lista de endereçamento.

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

O cmdlet Send-MailMessage usa o parâmetro From para especificar o remetente da mensagem. O parâmetro To especifica os destinatários da mensagem. O parâmetro Cc envia uma cópia da mensagem para o destinatário especificado. O parâmetro Cco envia uma cópia cega da mensagem. Uma cópia cega é um endereço de email oculto dos outros destinatários. O parâmetro Subject é a mensagem porque o parâmetro opcional Body não está incluído.

O parâmetro de Credenciais especifica que as credenciais de um administrador de domínio são usadas para enviar a mensagem. O parâmetro UseSsl especifica que a SSL (Secure Socket Layer) cria uma conexão segura.

Parâmetros

-Attachments

Especifica o caminho e os nomes de arquivo dos arquivos a serem anexados à mensagem de email. Você pode usar esse parâmetro ou canalizar os caminhos e nomes de arquivo para Send-MailMessage.

Tipo:String[]
Aliases:PsPath
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Bcc

Especifica os endereços de email que recebem uma cópia do email, mas não são listados como destinatários da mensagem. Insira nomes (opcional) e o endereço de email, como Name <someone@fabrikam.com>.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Body

Especifica o conteúdo da mensagem de email.

Tipo:String
Cargo:2
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-BodyAsHtml

Especifica que o valor do parâmetro corpo do contém HTML.

Tipo:SwitchParameter
Aliases:BAH
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Cc

Especifica os endereços de email para os quais uma cópia de carbono (CC) da mensagem de email é enviada. Insira nomes (opcional) e o endereço de email, como Name <someone@fabrikam.com>.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Credential

Especifica uma conta de usuário que tem permissão para executar essa ação. O padrão é o usuário atual.

Digite um nome de usuário, como User01 ou Domain01\User01. Ou insira um objeto PSCredential , como um do cmdlet .

Tipo:PSCredential
Cargo:Named
Valor padrão:Current user
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeliveryNotificationOption

Especifica as opções de notificação de entrega para a mensagem de email. Você pode especificar vários valores. Nenhum é o valor padrão. O alias desse parâmetro é DNO.

As notificações de entrega são enviadas para o endereço no parâmetro From.

Os valores aceitáveis para esse parâmetro são os seguintes:

  • Nenhum: nenhuma notificação.
  • OnSuccess: notifique se a entrega foi bem-sucedida.
  • OnFailure: notifique se a entrega não foi bem-sucedida.
  • Atraso: notifique se a entrega está atrasada.
  • Nunca: nunca notifique.
Tipo:DeliveryNotificationOptions
Aliases:DNO
Valores aceitos:None, OnSuccess, OnFailure, Delay, Never
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Encoding

Especifica o tipo de codificação para o arquivo de destino. O valor padrão é Padrão.

Os valores aceitáveis para esse parâmetro são os seguintes:

  • ascii usa conjunto de caracteres ASCII (7 bits).
  • BigEndianUnicode usa UTF-16 com a ordem de bytes big-endian.
  • padrão usa a codificação que corresponde à página de código ativo do sistema (geralmente ANSI).
  • OEM usa a codificação que corresponde à página de código OEM atual do sistema.
  • unicode usa UTF-16 com a ordem de byte little-endian.
  • UTF7 usa UTF-7.
  • UTF8 usa UTF-8.
  • UTF32 usa UTF-32 com a ordem de bytes little-endian.
Tipo:Encoding
Aliases:BE
Valores aceitos:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Cargo:Named
Valor padrão:Default
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-From

O parâmetro From é necessário. Esse parâmetro especifica o endereço de email do remetente. Insira um nome (opcional) e um endereço de email, como Name <someone@fabrikam.com>.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Port

Especifica uma porta alternativa no servidor SMTP. O valor padrão é 25, que é a porta SMTP padrão.

Tipo:Int32
Cargo:Named
Valor padrão:25
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Priority

Especifica a prioridade da mensagem de email. Normal é o padrão. Os valores aceitáveis para esse parâmetro são Normal, Alto e Baixo.

Tipo:MailPriority
Valores aceitos:Normal, High, Low
Cargo:Named
Valor padrão:Normal
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SmtpServer

Especifica o nome do servidor SMTP que envia a mensagem de email.

O valor padrão é o valor da variável de preferência $PSEmailServer. Se a variável de preferência não estiver definida e esse parâmetro não for usado, o comando Send-MailMessage falhará.

Tipo:String
Aliases:ComputerName
Cargo:3
Valor padrão:$PSEmailServer
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Subject

O parâmetro Subject é necessário. Esse parâmetro especifica o assunto da mensagem de email.

Tipo:String
Aliases:sub
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-To

O parâmetro To é necessário. Esse parâmetro especifica o endereço de email do destinatário. Se houver vários destinatários, separe seus endereços com uma vírgula (,). Insira nomes (opcional) e o endereço de email, como Name <someone@fabrikam.com>.

Tipo:String[]
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-UseSsl

O protocolo SSL (Secure Sockets Layer) é usado para estabelecer uma conexão segura com o computador remoto para enviar emails. Por padrão, o SSL não é usado.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

Você pode redirecionar o caminho e os nomes de arquivo de anexos para Send-MailMessage.

Saídas

None

Esse cmdlet não gera nenhuma saída.