Send-MailMessage

Artigo
10/30/2009

Envia uma mensagem de email.

Sintaxe

Send-MailMessage [-To] <string[]> [-Subject] <string> -From <string> [[-Body] <string>] [[-SmtpServer] <string>] [-Attachments <string[]>] [-Bcc <string[]>] [-BodyAsHtml] [-Cc <string[]>] [-Credential <PSCredential>] [-DeliveryNotificationOption {<None> | <OnSuccess> | <OnFailure> | <Delay> | <Never>}] [-Encoding <Encoding>] [-Priority {<Normal> | <Low> | <High>}] [-UseSsl] [<CommonParameters>]

Descrição

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

Parâmetros

-Attachments <string[]>

Especifica os caminho e nomes dos arquivos a serem anexados à mensagem de email. É possível usar esse parâmetro ou canalizar os caminhos e os nomes de arquivos para o Send-MailMessage.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	true (ByValue)
Aceitar caracteres curinga?	false

-Bcc <string[]>

Especifica os endereços de email que recebem uma cópia do email, mas que não estão listados como destinatários da mensagem. Digite nomes (opcional) e endereços de email, como "Nome <nome@example.com>".

Necessário?	false
Posição?	named
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Body <string>

Especifica o corpo (conteúdo) da mensagem de email.

Necessário?	false
Posição?	3
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-BodyAsHtml

Indica que o valor do parâmetro Body contém código HTML.

Necessário?	false
Posição?	named
Valor padrão	False
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Cc <string[]>

Especifica os endereços de email para os quais um cópia carbono (CC) da mensagem de email é enviada. Digite nomes (opcional) e endereços de email, como "Nome <nome@example.com>".

Necessário?	false
Posição?	named
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Credential <PSCredential>

Especifica uma conta de usuário com 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 o retornado pelo cmdlet Get-Credential.

Necessário?	false
Posição?	named
Valor padrão	Usuáro atual
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-DeliveryNotificationOption <DeliveryNotificationOptions>

Especifica as opções de notificação de entrega da mensagem de email. É possível especificar vários valores. "None" é o valor padrão. O alias desse parâmetro é "dno".

As notificações de entrega são enviadas em uma mensagem de email para o endereço especificado no valor do parâmetro To.

Os valores válidos são:

-- None: nenhuma notificação.

-- OnSuccess: notificar se a entrega tiver êxito.

-- OnFailure: notificar se a entrega não tiver êxito.

-- Delay: notificar se a entrega for atrasada.

--Never: nunca notificar.

Necessário?	false
Posição?	named
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Encoding <Encoding>

Especifica a codificação usada para o corpo e o assunto. Os valores válidos são ASCII, UTF8, UTF7, UTF32, Unicode, BigEndianUnicode, Default e OEM. O padrão é ASCII.

Necessário?	false
Posição?	named
Valor padrão	ASCII
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-From <string>

Especifica o endereço do qual o email é enviado. Digite um nome (opcional) e um endereço de email, como "Nome <nome@example.com>". Esse parâmetro é obrigatório.

Necessário?	true
Posição?	named
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Priority <MailPriority>

Especifica a prioridade da mensagem de email. Os valores válidos são Normal, High e Low. O padrão é Normal.

Necessário?	false
Posição?	named
Valor padrão	Normal.
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-SmtpServer <string>

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 for definida e esse parâmetro for omitido, o comando falhará.

Necessário?	false
Posição?	4
Valor padrão	$PSEmailServer
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Subject <string>

Especifica o assunto da mensagem de email. Esse parâmetro é obrigatório.

Necessário?	true
Posição?	2
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-To <string[]>

Especifica os endereços para os quais o email é enviado. Digite nomes (opcional) e endereços de email, como "Nome <nome@example.com>". Esse parâmetro é obrigatório.

Necessário?	true
Posição?	1
Valor padrão	Nenhum
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-UseSsl

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

Necessário?	false
Posição?	named
Valor padrão	False
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

System.String

É possível canalizar os caminho e nomes dos arquivos de anexos para o Send-MailMessage.

Saídas

Nenhum

Este cmdlet não gera nenhuma saída.

Exemplo 1

C:\PS>send-mailmessage -to "User01 <user01@example.com>" -from "User02 <user02@example.com>" -subject "Test mail"

Descrição
-----------
Esse comando envia uma mensagem de email de User01 para User02. 

A mensagem de email tem um assunto, que é obrigatório, mas não tem um corpo, que é opcional. Além disso, como o parâmetro SmtpServer não é especificado, o Send-MailMessage usa o valor da variável de preferência $PSEmailServer do servidor SMTP.

Exemplo 2

C:\PS>send-mailmessage -from "User01 <user01@example.com>" -to "User02 <user02@example.com>", "User03 <user03@example.com>" -subject "Sending the Attachment" -body "Forgot to send the attachment. Sending now." -Attachment "data.csv" -priority High -dno onSuccess, onFailure -smtpServer smtp.fabrikam.com

Descrição
-----------
Esse comando envia mensagem de email com um anexo do User01 para dois outros usuários. 

Ele especifica um valor de prioridade de "High" e solicita uma notificação de entrega por email quando as mensagens de email forem entregues ou quando falharem.

Exemplo 3

C:\PS>send-mailmessage -to "User01 <user01@example.com>" -from "ITGroup <itdept@example.com>" -cc "User02 <user02@example.com>" -bcc ITMgr <itmgr@example.com> -subject "Don't forget today's meeting!" -credential domain01\admin01 -useSSL

Descrição
-----------
Esse comando envia uma mensagem de email do User01 para a lista de endereçamento ITGroup com uma cópia (CC) para o User02 e uma cópia oculta (BCC) para o gerente de TI (ITMgr).

O comando usa as credenciais de um administrador de domínio e o parâmetro UseSSL.

Compartilhar via