Send-MailMessage

  • Referentie
Module:
Microsoft.PowerShell.Utility

Hiermee wordt een e-mailbericht verzonden.

Syntax

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

Description

De Send-MailMessage cmdlet verzendt een e-mailbericht vanuit PowerShell.

U moet een SMTP-server (Simple Mail Transfer Protocol) opgeven of de Send-MailMessage opdracht mislukt. Gebruik de parameter SmtpServer of stel de $PSEmailServer variabele in op een geldige SMTP-server. De waarde waaraan is toegewezen $PSEmailServer , is de standaard-SMTP-instelling voor PowerShell. Zie about_Preference_Variables voor meer informatie.

Waarschuwing

De cmdlet Send-MailMessage is verouderd. Deze cmdlet garandeert geen beveiligde verbindingen met SMTP-servers. Hoewel er geen onmiddellijke vervanging beschikbaar is in PowerShell, raden we u aan niet te gebruiken Send-MailMessage. Zie Platformcompatibiliteitsnotitie DE0005 voor meer informatie.

Voorbeelden

Voorbeeld 1: Een e-mailbericht van de ene persoon naar een andere persoon verzenden

In dit voorbeeld wordt een e-mailbericht van de ene persoon naar een andere persoon verzonden.

De parameters Van, Aan en Onderwerp zijn vereist voor Send-MailMessage. In dit voorbeeld wordt de standaardvariabele $PSEmailServer voor de SMTP-server gebruikt, dus de parameter SmtpServer is niet nodig.

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

De Send-MailMessage cmdlet gebruikt de parameter From om de afzender van het bericht op te geven. De parameter Aan geeft de geadresseerde van het bericht op. De parameter Onderwerp gebruikt de teksttekenreeks Test mail als het bericht omdat de optionele hoofdtekstparameter niet is opgenomen.

Voorbeeld 2: Een bijlage verzenden

In dit voorbeeld wordt een e-mailbericht met een bijlage verzonden.

$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

De Send-MailMessage cmdlet gebruikt de parameter From om de afzender van het bericht op te geven. De parameter Aan geeft de geadresseerden van het bericht op. De parameter Onderwerp beschrijft de inhoud van het bericht. De parameter Hoofdtekst is de inhoud van het bericht.

De parameter Bijlagen specificeert het bestand in de huidige map die is gekoppeld aan het e-mailbericht. Met de parameter Prioriteit wordt het bericht ingesteld op High prioriteit. Met de parameter DeliveryNotificationOption worden twee waarden opgegeven, OnSuccess en OnFailure. De afzender ontvangt e-mailmeldingen om het slagen of mislukken van de berichtbezorging te bevestigen. Met de parameter SmtpServer wordt de SMTP-server ingesteld op smtp.fabrikam.com.

Voorbeeld 3: E-mail verzenden naar een adressenlijst

In dit voorbeeld wordt een e-mailbericht naar een adressenlijst verzonden.

$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

De Send-MailMessage cmdlet gebruikt de parameter From om de afzender van het bericht op te geven. De parameter Aan geeft de geadresseerden van het bericht op. De CC-parameter verzendt een kopie van het bericht naar de opgegeven geadresseerde. De BCC-parameter verzendt een blinde kopie van het bericht. Een blinde kopie is een e-mailadres dat verborgen is voor de andere geadresseerden. De parameter Onderwerp is het bericht omdat de optionele hoofdtekstparameter niet is opgenomen.

De referentieparameter specificeert de referenties van een domeinbeheerder worden gebruikt om het bericht te verzenden. De parameter UseSsl geeft aan dat Secure Socket Layer (SSL) een beveiligde verbinding maakt.

Parameters

-Attachments

Hiermee geeft u het pad en de bestandsnamen op van bestanden die moeten worden toegevoegd aan het e-mailbericht. U kunt deze parameter gebruiken of de paden en bestandsnamen doorsluisen naar Send-MailMessage.

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

-Bcc

Hiermee geeft u de e-mailadressen op die een kopie van de e-mail ontvangen, maar die niet worden vermeld als geadresseerden van het bericht. Voer namen (optioneel) en het e-mailadres in, zoals Name <someone@fabrikam.com>.

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

-Body

Hiermee geeft u de inhoud van het e-mailbericht.

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

-BodyAsHtml

Hiermee geeft u op dat de waarde van de parameter Body HTML bevat.

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

-Cc

Hiermee geeft u de e-mailadressen op waarnaar een carbon copy (CC) van het e-mailbericht wordt verzonden. Voer namen (optioneel) en het e-mailadres in, zoals Name <someone@fabrikam.com>.

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

-Credential

Hiermee geeft u een gebruikersaccount op dat gemachtigd is om deze actie uit te voeren. Standaard is dit de huidige gebruiker.

Typ een gebruikersnaam, zoals User01 of Domain01\User01. U kunt ook een PSCredential-object invoeren, zoals een object uit de Get-Credential cmdlet.

Referenties worden opgeslagen in een PSCredential-object en het wachtwoord wordt opgeslagen als SecureString.

Notitie

Zie Hoe veilig is SecureString SecureString?voor meer informatie over SecureString-gegevensbeveiliging.

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

-DeliveryNotificationOption

Hiermee geeft u de opties voor bezorgingsmeldingen voor het e-mailbericht op. U kunt meerdere waarden opgeven. Geen is de standaardwaarde. De alias voor deze parameter is DNO.

De bezorgingsmeldingen worden verzonden naar het adres in de parameter Van .

De acceptabele waarden voor deze parameter zijn als volgt:

  • None: Geen melding.
  • OnSuccess: Informeer of de levering is geslaagd.
  • OnFailure: Informeer of de levering mislukt.
  • Delay: Informeer of de levering is vertraagd.
  • Never: Nooit melden.

Deze waarden worden gedefinieerd als een opsomming op basis van vlaggen. U kunt meerdere waarden combineren om meerdere vlaggen in te stellen met behulp van deze parameter. De waarden kunnen worden doorgegeven aan de parameter DeliveryNotification als een matrix met waarden of als een door komma's gescheiden tekenreeks van deze waarden. De cmdlet combineert de waarden met behulp van een binaire OF-bewerking. Het doorgeven van waarden als een matrix is de eenvoudigste optie en u kunt ook tabvoltooiing gebruiken voor de waarden.

Type:DeliveryNotificationOptions
Aliases:DNO
Accepted values:None, OnSuccess, OnFailure, Delay, Never
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Encoding

Hiermee geeft u het type codering voor het doelbestand. De standaardwaarde is utf8NoBOM.

De acceptabele waarden voor deze parameter zijn als volgt:

  • ascii: gebruikt de codering voor de ASCII-tekenset (7-bits).
  • bigendianunicode: Codeert in UTF-16-indeling met behulp van de bytevolgorde big-endian.
  • bigendianutf32: Codeert in UTF-32-indeling met behulp van de bytevolgorde big-endian.
  • oem: maakt gebruik van de standaardcodering voor MS-DOS en consoleprogramma's.
  • unicode: Codeert in UTF-16-indeling met behulp van de bytevolgorde little-endian.
  • utf7: Codeert in UTF-7-indeling.
  • utf8: Codeert in UTF-8-indeling.
  • utf8BOM: Codeert in UTF-8-indeling met Byte Order Mark (BOM)
  • utf8NoBOM: Codeert in UTF-8-indeling zonder Byte Order Mark (BOM)
  • utf32: Codeert in UTF-32-indeling.

Vanaf PowerShell 6.2 staat de coderingsparameter ook numerieke id's toe van geregistreerde codepagina's (zoals -Encoding 1251) of tekenreeksnamen van geregistreerde codepagina's (zoals-Encoding "windows-1251"). Zie de .NET-documentatie voor Encoding.CodePage voor meer informatie.

Type:Encoding
Aliases:BE
Accepted values:ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:Named
Default value:ASCII
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-From

De parameter From is vereist. Met deze parameter geeft u het e-mailadres van de afzender op. Voer een naam (optioneel) en e-mailadres in, zoals Name <someone@fabrikam.com>.

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

-Port

Hiermee geeft u een alternatieve poort op de SMTP-server. De standaardwaarde is 25, de standaard SMTP-poort.

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

-Priority

Hiermee geeft u de prioriteit van het e-mailbericht. Normaal is de standaardwaarde. De acceptabele waarden voor deze parameter zijn Normaal, Hoog en Laag.

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

-ReplyTo

Hiermee geeft u extra e-mailadressen op (behalve het Van-adres) dat moet worden gebruikt om dit bericht te beantwoorden. Voer namen (optioneel) en het e-mailadres in, zoals Name <someone@fabrikam.com>.

Deze parameter is geïntroduceerd in PowerShell 6.2.

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

-SmtpServer

Hiermee geeft u de naam op van de SMTP-server die het e-mailbericht verzendt.

De standaardwaarde is de waarde van de $PSEmailServer voorkeursvariabele. Als de voorkeursvariabele niet is ingesteld en deze parameter niet wordt gebruikt, mislukt de Send-MailMessage opdracht.

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

-Subject

De onderwerpparameter is niet vereist. Met deze parameter wordt het onderwerp van het e-mailbericht opgegeven.

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

-To

De parameter Aan is vereist. Met deze parameter geeft u het e-mailadres van de geadresseerde op. Voer namen (optioneel) en het e-mailadres in, zoals Name <someone@fabrikam.com>.

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

-UseSsl

Het SSL-protocol (Secure Sockets Layer) wordt gebruikt om een beveiligde verbinding tot stand te brengen met de externe computer om e-mail te verzenden. SSL wordt standaard niet gebruikt.

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

Invoerwaarden

String

U kunt het pad en de bestandsnamen van bijlagen naar deze cmdlet doorsluisen.

Uitvoerwaarden

None

Deze cmdlet retourneert geen uitvoer.

Notities

De cmdlet Send-MailMessage is verouderd. Zie Platformcompatibiliteitsnotitie DE0005 voor meer informatie. Deze cmdlet garandeert geen beveiligde verbindingen met SMTP-servers.

DE0005 stelt voor het gebruik van de bibliotheek van derden, MailKit. Als u Exchange Online gebruikt, kunt u de Send-MgUserMail van de Microsoft Graph PowerShell SDK gebruiken.