Send-MailMessage

Sintaxe

All

Send-MailMessage
    [[-Body] <String>]
    [[-SmtpServer] <String>]
    [[-Subject] <String>]
    [-To] <String[]>
    -From <String>
    [-Attachments <String[]>]
    [-Bcc <String[]>]
    [-BodyAsHtml]
    [-Encoding <Encoding>]
    [-Cc <String[]>]
    [-DeliveryNotificationOption <DeliveryNotificationOptions>]
    [-Priority <MailPriority>]
    [-ReplyTo <String[]>]
    [-Credential <PSCredential>]
    [-UseSsl]
    [-Port <Int32>]
    [<CommonParameters>]

Description

Exemplos

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

$sendMailMessageSplat = @{
    From = 'User01 <user01@fabrikam.com>'
    To = 'User02 <user02@fabrikam.com>'
    Subject = 'Test mail'
}
Send-MailMessage @sendMailMessageSplat

Exemplo 2: Enviar 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 @sendMailMessageSplat

Exemplo 3: Enviar 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 @sendMailMessageSplat

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.

Propriedades do parâmetro

Conjuntos de parâmetros

-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 email, como Name <someone@fabrikam.com>.

Propriedades do parâmetro

Conjuntos de parâmetros

-Body

Especifica o conteúdo da mensagem de email.

Propriedades do parâmetro

Conjuntos de parâmetros

-BodyAsHtml

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

Propriedades do parâmetro

Conjuntos de parâmetros

-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>.

Propriedades do parâmetro

Conjuntos de parâmetros

-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 .

As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.

Propriedades do parâmetro

Conjuntos de parâmetros

-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:

• None: nenhuma notificação.
• OnSuccess: notifique se a entrega foi bem-sucedida.
• OnFailure: notifique se a entrega não tiver êxito.
• Delay: notifique se a entrega está atrasada.
• Never: nunca notifique.

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores 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 binária-OR. Passar valores como uma matriz é a opção mais simples e também permite usar o preenchimento com Tab nos valores.

Propriedades do parâmetro

Conjuntos de parâmetros

-Encoding

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

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

• ascii: usa a codificação para o conjunto de caracteres ASCII (7 bits).
• ansi: usa a codificação para a página de código ANSI da cultura vigente. Essa opção foi adicionada ao PowerShell 7.4.
• bigendianunicode: codifica em formato UTF-16 usando a ordem de byte big-endian.
• bigendianutf32: codifica em formato UTF-32 usando a ordem de byte big-endian.
• oem: usa a codificação padrão para MS-DOS e programas de console.
• unicode: codifica em formato UTF-16 usando a ordem de byte little-endian.
• utf7: codifica em formato UTF-7.
• utf8: codifica em formato UTF-8.
• utf8BOM: codifica em formato UTF-8 com BOM (marca de ordem de byte)
• utf8NoBOM: codifica no formato UTF-8 sem BOM (Byte Order Mark)
• utf32: codifica em formato UTF-32.

A partir do PowerShell 6.2, o parâmetro de codificação de também permite IDs numéricas de páginas de código registradas (como ) ou nomes de cadeia de caracteres de páginas de código registradas (como ). Para obter mais informações, consulte a documentação do .NET para Encoding.CodePage.

A partir do PowerShell 7.4, você pode usar o valor Ansi para o parâmetro de Codificação para passar a ID numérica da página de código ANSI da cultura atual sem precisar especificá-la manualmente.

Propriedades do parâmetro

Conjuntos de parâmetros

-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>.

Propriedades do parâmetro

Conjuntos de parâmetros

-Port

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

Propriedades do parâmetro

Conjuntos de parâmetros

-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.

Propriedades do parâmetro

Conjuntos de parâmetros

-ReplyTo

Especifica endereços de email adicionais (além do endereço De) a serem usados para responder a essa mensagem. Insira nomes (opcional) e o endereço de email, como Name <someone@fabrikam.com>.

Esse parâmetro foi introduzido no PowerShell 6.2.

Propriedades do parâmetro

Conjuntos de parâmetros

-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á.

Propriedades do parâmetro

Conjuntos de parâmetros

-Subject

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

Propriedades do parâmetro

Conjuntos de parâmetros

-To

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

Propriedades do parâmetro

Conjuntos de parâmetros

-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.

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

String

Saídas

None

Observações

Links Relacionados

• about_Preference_Variables
• Get-Credential