Send-MailMessage
Envia uma mensagem de email.
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
O Send-MailMessage cmdlet envia uma mensagem de email de dentro do PowerShell.
Você deve especificar um servidor SMTP (Simple Mail Transfer Protocol) ou o Send-MailMessage comando falhará. Use o parâmetro SmtpServer ou defina a $PSEmailServer variável como um servidor SMTP válido.
O valor atribuído a $PSEmailServer é a configuração SMTP padrão do PowerShell. Para obter mais informações, consulte about_Preference_Variables.
Aviso
Send-MailMessage está obsoleto. Esse cmdlet não garante conexões seguras com servidores SMTP. Embora não haja substituição imediata disponível no PowerShell, recomendamos que você não use Send-MailMessageo . Para obter mais informações, consulte a nota de compatibilidade de plataforma DE0005.
Exemplos
Exemplo 1: Enviar um email de uma pessoa para outra pessoa
Este exemplo envia uma mensagem de email de uma pessoa para outra.
Os parâmetros De, Para e Assunto são exigidos pelo Send-MailMessage. Este exemplo usa a variável padrão $PSEmailServer para o servidor SMTP, portanto, o parâmetro SmtpServer não é necessário.
$sendMailMessageSplat = @{
From = 'User01 <user01@fabrikam.com>'
To = 'User02 <user02@fabrikam.com>'
Subject = 'Test mail'
}
Send-MailMessage @sendMailMessageSplatO Send-MailMessage cmdlet 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 Test mail como a mensagem porque o parâmetro opcional Body não está incluído.
Exemplo 2: Enviar um anexo
Este exemplo envia uma mensagem de email com um anexo.
$sendMailMessageSplat = @{
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'
}
Send-MailMessage @sendMailMessageSplatO Send-MailMessage cmdlet 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 High prioridade. O parâmetro DeliveryNotificationOption especifica dois valores OnSuccess e OnFailure. O remetente receberá notificações por e-mail para confirmar o sucesso ou falha na 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.
$sendMailMessageSplat = @{
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 = $true
}
Send-MailMessage @sendMailMessageSplatO Send-MailMessage cmdlet 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 Bcc envia uma cópia oculta da mensagem. Uma cópia oculta é um endereço de e-mail 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 Credential especifica que as credenciais de um administrador de domínio são usadas para enviar a mensagem. O parâmetro UseSsl especifica que 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.
| Type: | String[] |
| Aliases: | PsPath |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Bcc
Especifica os endereços de email que recebem uma cópia do email, mas não estão listados como destinatários da mensagem. Insira nomes (opcional) e o endereço de e-mail, como Name <someone@fabrikam.com>.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Body
Especifica o conteúdo da mensagem de email.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyAsHtml
Especifica que o valor do parâmetro Body contém HTML.
| Type: | SwitchParameter |
| Aliases: | BAH |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Cc
Especifica os endereços de email para os quais uma cópia carbono (CC) da mensagem de email é enviada. Insira nomes (opcional) e o endereço de e-mail, como Name <someone@fabrikam.com>.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Especifica uma conta de usuário que tem permissão para executar esta 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 Get-Credential cmdlet.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Observação
Para obter mais informações sobre a proteção de dados do SecureString , consulte Quão seguro é o SecureString?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeliveryNotificationOption
Especifica as opções de notificação de entrega para a mensagem de email. Você pode especificar vários valores . None é o valor padrão. O alias para esse parâmetro é DNO.
As notificações de entrega são enviadas para o endereço no parâmetro De .
Os valores aceitáveis para esse parâmetro são os seguintes:
None: Sem notificação.OnSuccess: Notifique se a entrega for bem-sucedida.OnFailure: Notifique se a entrega não for bem-sucedida.Delay: Notificar se a entrega estiver atrasada.Never: Nunca notifique.
Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores juntos para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro DeliveryNotification como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão de tabulação nos valores.
| 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 o tipo de codificação para o arquivo de destino. O valor padrão é Default.
Os valores aceitáveis para esse parâmetro são os seguintes:
ASCIIUsa o conjunto de caracteres ASCII (7 bits).BigEndianUnicodeUsa UTF-16 com a ordem de bytes big-endian.DefaultUsa a codificação que corresponde à página de código ativo do sistema (geralmente ANSI).OEMUsa a codificação que corresponde à página de código OEM atual do sistema.UnicodeUsa UTF-16 com a ordem de bytes little-endian.UTF7Usa UTF-7.UTF8Usa UTF-8.UTF32Usa UTF-32 com a ordem 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
O parâmetro From é obrigatório. Este parâmetro especifica o endereço de email do remetente. Insira um nome (opcional) e um endereço de e-mail, como Name <someone@fabrikam.com>.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Especifica uma porta alternativa no servidor SMTP. O valor padrão é 25, que é a porta SMTP padrão.
| Type: | Int32 |
| Position: | Named |
| Default value: | 25 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | MailPriority |
| Accepted values: | Normal, High, Low |
| Position: | Named |
| Default value: | Normal |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SmtpServer
Especifica o nome do servidor SMTP que envia a mensagem de email.
O valor padrão é o $PSEmailServer valor da variável de preferência. Se a variável de preferência não estiver definida e esse parâmetro não for usado, o Send-MailMessage comando falhará.
| Type: | String |
| Aliases: | ComputerName |
| Position: | 3 |
| Default value: | $PSEmailServer |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Subject
O parâmetro Subject não é necessário. Este parâmetro especifica o assunto da mensagem de email.
| Type: | String |
| Aliases: | sub |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-To
O parâmetro To é obrigatório. Este parâmetro especifica o endereço de email do destinatário. Insira nomes (opcional) e o endereço de e-mail, como Name <someone@fabrikam.com>.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
Você pode canalizar o caminho e os nomes de arquivo dos anexos para esse cmdlet.
Saídas
None
Esse cmdlet não retorna nenhuma saída.
Observações
Send-MailMessage está obsoleto. Para obter mais informações, consulte a nota de compatibilidade de plataforma DE0005. Esse cmdlet não garante conexões seguras com servidores SMTP.
DE0005 sugere o uso da biblioteca de terceiros, MailKit. Se você estiver usando o Exchange Online, poderá usar o Send-MgUserMail do SDK do Microsoft Graph PowerShell.
Links Relacionados
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de