Partager via

Send-MailMessage

  • Référence
Module:
Microsoft.PowerShell.Utility

Envoie un e-mail.

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

L’applet Send-MailMessage de commande envoie un message électronique à partir de PowerShell.

Vous devez spécifier un serveur SMTP (Simple Mail Transfer Protocol) ou la Send-MailMessage commande échoue. Utilisez le paramètre SmtpServer ou définissez la $PSEmailServer variable sur un serveur SMTP valide. La valeur affectée à $PSEmailServer est le paramètre SMTP par défaut pour PowerShell. Pour plus d’informations, consultez about_Preference_Variables.

Exemples

Exemple 1 : Envoyer un e-mail d’une personne à une autre personne

Cet exemple envoie un e-mail d’une personne à une autre personne.

Les paramètres From, To et Subject sont requis par Send-MailMessage. Cet exemple utilise la variable par défaut $PSEmailServer pour le serveur SMTP. Le paramètre SmtpServer n’est donc pas nécessaire.

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

L’applet Send-MailMessage de commande utilise le paramètre From pour spécifier l’expéditeur du message. Le paramètre To spécifie le destinataire du message. Le paramètre Subject utilise la chaîne de texte Courrier de test comme message, car le paramètre facultatif Body n’est pas inclus.

Exemple 2 : Envoyer une pièce jointe

Cet exemple envoie un e-mail avec une pièce jointe.

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'

L’applet Send-MailMessage de commande utilise le paramètre From pour spécifier l’expéditeur du message. Le paramètre To spécifie les destinataires du message. Le paramètre Subject décrit le contenu du message. Le paramètre Body est le contenu du message.

Le paramètre Attachments spécifie le fichier dans le répertoire actif joint au message électronique. Le paramètre Priority définit le message sur Priorité élevée . Le paramètre -DeliveryNotificationOption spécifie deux valeurs, OnSuccess et OnFailure. L’expéditeur recevra Notifications par e-mail pour confirmer la réussite ou l’échec de la remise du message. Le paramètre SmtpServer définit le serveur SMTP sur smtp.fabrikam.com.

Exemple 3 : Envoyer un e-mail à une liste de diffusion

Cet exemple envoie un e-mail à une liste de diffusion.

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

L’applet Send-MailMessage de commande utilise le paramètre From pour spécifier l’expéditeur du message. Le paramètre To spécifie les destinataires du message. Le paramètre Cc envoie une copie du message au destinataire spécifié. Le paramètre Cci envoie une copie aveugle du message. Une copie aveugle est une adresse e-mail masquée par les autres destinataires. Le paramètre Subject est le message, car le paramètre facultatif Body n’est pas inclus.

Le paramètre Credential spécifie que les informations d’identification d’un administrateur de domaine sont utilisées pour envoyer le message. Le paramètre UseSsl spécifie que ssl (Secure Socket Layer) crée une connexion sécurisée.

Paramètres

-Attachments

Spécifie le chemin d’accès et les noms de fichiers à joindre au message électronique. Vous pouvez utiliser ce paramètre ou diriger les chemins d’accès et les noms de fichiers vers Send-MailMessage.

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

-Bcc

Spécifie les adresses e-mail qui reçoivent une copie du courrier, mais qui ne sont pas répertoriées en tant que destinataires du message. Entrez les noms (facultatifs) et l’adresse e-mail, par Name <someone@fabrikam.com>exemple .

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

-Body

Spécifie le contenu du message électronique.

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

-BodyAsHtml

Spécifie que la valeur du paramètre Body contient du code HTML.

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

-Cc

Spécifie les adresses e-mail auxquelles une copie carbone (CC) du message électronique est envoyée. Entrez les noms (facultatifs) et l’adresse e-mail, par Name <someone@fabrikam.com>exemple .

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

-Credential

Spécifie un compte d’utilisateur qui a l’autorisation d’exécuter cette action. La valeur par défaut est l’utilisateur actuel.

Tapez un nom d’utilisateur, tel que User01 ou Domain01\User01. Vous pouvez également entrer un objet PSCredential , tel qu’un objet à partir de l’applet Get-Credential de commande.

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

-DeliveryNotificationOption

Spécifie les options de notification de remise pour le message électronique. Vous pouvez spécifier plusieurs valeurs. None est la valeur par défaut. L’alias de ce paramètre est DNO.

Les notifications de remise sont envoyées à l’adresse dans le paramètre From .

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Aucun : aucune notification.
  • OnSuccess : notifier si la remise réussit.
  • OnFailure : notifier si la livraison échoue.
  • Délai : notifier si la livraison est retardée.
  • Jamais : ne jamais notifier.
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

Spécifie le type de codage du fichier cible. La valeur par défaut est Default.

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • ASCII Utilise un jeu de caractères ASCII (7 bits).
  • BigEndianUnicode Utilise UTF-16 avec l’ordre d’octets big-endian.
  • Par défaut Utilise l’encodage qui correspond à la page de code active du système (généralement ANSI).
  • OEM Utilise l’encodage qui correspond à la page de code OEM actuelle du système.
  • Unicode Utilise UTF-16 avec l’ordre d’octets little endian.
  • UTF7 Utilise UTF-7.
  • UTF8 Utilise UTF-8.
  • UTF32 Utilise UTF-32 avec l’ordre d’octets 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

Le paramètre From est obligatoire. Ce paramètre spécifie l’adresse e-mail de l’expéditeur. Entrez un nom (facultatif) et une adresse e-mail, par exemple Name <someone@fabrikam.com>.

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

-Port

Spécifie un autre port du serveur SMTP. La valeur par défaut est 25, qui est le port SMTP par défaut.

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

-Priority

Spécifie la priorité du message électronique. Normal est la valeur par défaut. Les valeurs acceptables pour ce paramètre sont Normal, High et Low.

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

-SmtpServer

Spécifie le nom du serveur SMTP qui envoie l’e-mail.

La valeur par défaut est la valeur de la $PSEmailServer variable de préférence. Si la variable de préférence n’est pas définie et que ce paramètre n’est pas utilisé, la Send-MailMessage commande échoue.

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

-Subject

Le paramètre Subject est obligatoire. Ce paramètre spécifie l’objet du message électronique.

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

-To

Le paramètre To est obligatoire. Ce paramètre spécifie l’adresse e-mail du destinataire. S’il existe plusieurs destinataires, séparez leurs adresses par une virgule (,). Entrez les noms (facultatifs) et l’adresse e-mail, par Name <someone@fabrikam.com>exemple .

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

-UseSsl

Le protocole SSL (Secure Sockets Layer) est utilisé pour établir une connexion sécurisée à l’ordinateur distant pour envoyer des messages. Par défaut, SSL n'est pas utilisé.

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

Entrées

String

Vous pouvez diriger le chemin d’accès et les noms de fichiers des pièces jointes vers Send-MailMessage.

Sorties

None

Cette applet de commande ne génère aucune sortie.