Send-MailMessage
Wysyła wiadomość e-mail.
Składnia
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>]
Opis
Polecenie cmdlet Send-MailMessage
wysyła wiadomość e-mail z poziomu programu PowerShell.
Należy określić serwer SMTP (Simple Mail Transfer Protocol) lub polecenie Send-MailMessage
kończy się niepowodzeniem. Użyj parametru SmtpServer lub ustaw zmienną $PSEmailServer
na prawidłowy serwer SMTP.
Wartość przypisana do $PSEmailServer
jest domyślnym ustawieniem SMTP dla programu PowerShell. Aby uzyskać więcej informacji, zobacz about_Preference_Variables.
Przykłady
Przykład 1. Wysyłanie wiadomości e-mail od jednej osoby do innej osoby
Ten przykład wysyła wiadomość e-mail od jednej osoby do innej osoby.
Parametry From, Toi Subject są wymagane przez Send-MailMessage
. W tym przykładzie użyto domyślnej zmiennej $PSEmailServer
dla serwera SMTP, więc parametr SmtpServer nie jest wymagany.
Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>' -Subject 'Test mail'
Polecenie cmdlet Send-MailMessage
używa parametru From w celu określenia nadawcy komunikatu. Parametr To określa adresata wiadomości. Parametr Subject używa ciągu tekstowego Test mail jako wiadomości, ponieważ opcjonalny parametr Treść nie jest dołączony.
Przykład 2. Wysyłanie załącznika
Ten przykład wysyła wiadomość e-mail z załącznikiem.
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'
Polecenie cmdlet Send-MailMessage
używa parametru From w celu określenia nadawcy komunikatu. Parametr Do określa adresatów wiadomości. Parametr Temat opisuje zawartość komunikatu. Parametr Treść jest zawartością komunikatu.
Parametr Attachments określa plik w bieżącym katalogu dołączonym do wiadomości e-mail. Parametr priorytetu
Przykład 3. Wysyłanie wiadomości e-mail na listę adresową
W tym przykładzie wiadomość e-mail jest wysyłana do listy adresowej.
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
Polecenie cmdlet Send-MailMessage
używa parametru From w celu określenia nadawcy komunikatu. Parametr Do określa adresatów wiadomości. Parametr CC wysyła kopię wiadomości do określonego adresata. Parametr Bcc wysyła ślepą kopię komunikatu. Kopia ślepa to adres e-mail, który jest ukryty przed innymi adresatami. Parametr Temat jest komunikatem, ponieważ opcjonalny parametr Treść nie jest uwzględniony.
Parametr Credential określa poświadczenia administratora domeny są używane do wysyłania komunikatu. Parametr UseSsl określa, że protokół Secure Socket Layer (SSL) tworzy bezpieczne połączenie.
Parametry
-Attachments
Określa ścieżkę i nazwy plików, które mają być dołączone do wiadomości e-mail. Możesz użyć tego parametru lub potoku ścieżek i nazw plików, aby Send-MailMessage
.
Typ: | String[] |
Aliasy: | PsPath |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Bcc
Określa adresy e-mail, które otrzymują kopię wiadomości, ale nie są wyświetlane jako adresaci wiadomości. Wprowadź nazwy (opcjonalnie) i adres e-mail, na przykład Name <someone@fabrikam.com>
.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Body
Określa zawartość wiadomości e-mail.
Typ: | String |
Position: | 2 |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-BodyAsHtml
Określa, że wartość parametru Body zawiera kod HTML.
Typ: | SwitchParameter |
Aliasy: | BAH |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Cc
Określa adresy e-mail, do których jest wysyłana kopia węgla (CC) wiadomości e-mail. Wprowadź nazwy (opcjonalnie) i adres e-mail, na przykład Name <someone@fabrikam.com>
.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Credential
Określa konto użytkownika, które ma uprawnienia do wykonania tej akcji. Wartość domyślna to bieżący użytkownik.
Wpisz nazwę użytkownika, taką jak User01 lub Domain01\User01. Możesz też wprowadzić obiekt PSCredential, taki jak obiekt z polecenia cmdlet Get-Credential
.
Typ: | PSCredential |
Position: | Named |
Domyślna wartość: | Current user |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-DeliveryNotificationOption
Określa opcje powiadomienia o dostarczaniu wiadomości e-mail. Można określić wiele wartości. Brak jest wartością domyślną. Alias dla tego parametru to DNO.
Powiadomienia o dostarczaniu są wysyłane do adresu w parametrze From.
Dopuszczalne wartości tego parametru są następujące:
- Brak: brak powiadomienia.
- OnSuccess: Powiadom, czy dostarczanie zakończy się pomyślnie.
- OnFailure: powiadom, czy dostarczanie nie powiedzie się.
- opóźnienie: powiadom, czy dostawa jest opóźniona.
- Nigdy nie: Nigdy nie powiadamiaj.
Typ: | DeliveryNotificationOptions |
Aliasy: | DNO |
Dopuszczalne wartości: | None, OnSuccess, OnFailure, Delay, Never |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Encoding
Określa typ kodowania dla pliku docelowego. Wartość domyślna to Wartość domyślna.
Dopuszczalne wartości tego parametru są następujące:
- ASCII używa zestawu znaków ASCII (7-bitowego).
- BigEndianUnicode używa formatu UTF-16 z kolejnością bajtów big-endian.
- domyślna Używa kodowania odpowiadającego aktywnej stronie kodu systemu (zwykle ANSI).
- OEM Używa kodowania odpowiadającego bieżącej stronie kodowej producenta OEM systemu.
- unicode używa utF-16 z małą kolejnością bajtów endian.
- UTF7 używa protokołu UTF-7.
- UTF8 używa protokołu UTF-8.
- UTF32 używa formatu UTF-32 z kolejnością bajtów little-endian.
Typ: | Encoding |
Aliasy: | BE |
Dopuszczalne wartości: | ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32 |
Position: | Named |
Domyślna wartość: | Default |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-From
Parametr From jest wymagany. Ten parametr określa adres e-mail nadawcy. Wprowadź nazwę (opcjonalnie) i adres e-mail, na przykład Name <someone@fabrikam.com>
.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Port
Określa alternatywny port na serwerze SMTP. Wartość domyślna to 25, czyli domyślny port SMTP.
Typ: | Int32 |
Position: | Named |
Domyślna wartość: | 25 |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Priority
Określa priorytet wiadomości e-mail. Wartość normalna to wartość domyślna. Dopuszczalne wartości tego parametru to Normal, High i Low.
Typ: | MailPriority |
Dopuszczalne wartości: | Normal, High, Low |
Position: | Named |
Domyślna wartość: | Normal |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-SmtpServer
Określa nazwę serwera SMTP, który wysyła wiadomość e-mail.
Wartość domyślna to wartość zmiennej preferencji $PSEmailServer
. Jeśli zmienna preferencji nie jest ustawiona i ten parametr nie jest używany, polecenie Send-MailMessage
kończy się niepowodzeniem.
Typ: | String |
Aliasy: | ComputerName |
Position: | 3 |
Domyślna wartość: | $PSEmailServer |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Subject
Parametr Subject jest wymagany. Ten parametr określa temat wiadomości e-mail.
Typ: | String |
Aliasy: | sub |
Position: | 1 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-To
Wymagany jest parametr Do. Ten parametr określa adres e-mail odbiorcy. Jeśli istnieje wielu adresatów, rozdziel ich adresy przecinkami (,
). Wprowadź nazwy (opcjonalnie) i adres e-mail, na przykład Name <someone@fabrikam.com>
.
Typ: | String[] |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-UseSsl
Protokół SSL (Secure Sockets Layer) służy do nawiązywania bezpiecznego połączenia z komputerem zdalnym w celu wysyłania poczty. Domyślnie protokół SSL nie jest używany.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
Możesz przekazać ścieżkę i nazwy plików załączników do Send-MailMessage
.
Dane wyjściowe
None
To polecenie cmdlet nie generuje żadnych danych wyjściowych.