Send-MailMessage
電子メール メッセージを送信します。
構文
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>]
説明
Send-MailMessage
コマンドレットは、PowerShell 内から電子メール メッセージを送信します。
簡易メール転送プロトコル (SMTP) サーバーを指定する必要があります。または、Send-MailMessage
コマンドが失敗します。
SmtpServer パラメーターを使用するか、$PSEmailServer
変数を有効な SMTP サーバーに設定します。
$PSEmailServer
に割り当てられる値は、PowerShell の既定の SMTP 設定です。 詳細については、about_Preference_Variablesを参照してください。
例
例 1: あるユーザーから別のユーザーにメールを送信する
次の使用例は、あるユーザーから別のユーザーに電子メール メッセージを送信します。
From、To、および Subject パラメーターは、Send-MailMessage
で必要です。 この例では、SMTP サーバーの既定の $PSEmailServer
変数を使用するため、SmtpServer パラメーターは必要ありません。
Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>' -Subject 'Test mail'
Send-MailMessage
コマンドレットは、From パラメーターを使用して、メッセージの送信者を指定します。
To パラメーターは、メッセージの受信者を指定します。
Subject パラメーターは、オプションの Body パラメーターが含まれていないため、テキスト文字列 Test mail をメッセージとして使用します。
例 2: 添付ファイルを送信する
この例では、添付ファイルを含む電子メール メッセージを送信します。
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'
Send-MailMessage
コマンドレットは、From パラメーターを使用して、メッセージの送信者を指定します。
To パラメーターは、メッセージの受信者を指定します。
Subject パラメーターは、メッセージの内容を記述します。
Body パラメーターは、メッセージの内容です。
Attachments パラメーターは、電子メール メッセージに添付される現在のディレクトリ内のファイルを指定します。 Priority パラメータは、メッセージを High priority に設定します。 -DeliveryNotificationOption パラメーターは、OnSuccess と OnFailure の 2 つの値を指定します。 送信者は、メッセージ配信の成功または失敗を確認する電子メール通知を受け取ります。 SmtpServer パラメータは、SMTP サーバを smtp.fabrikam.com に設定します。
例 3: メーリング リストにメールを送信する
次の使用例は、メール メッセージをメーリング リストに送信します。
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
Send-MailMessage
コマンドレットは、From パラメーターを使用して、メッセージの送信者を指定します。
To パラメーターは、メッセージの受信者を指定します。
Cc パラメーターは、メッセージのコピーを指定された受信者に送信します。
BCC パラメーターは、メッセージのブラインド コピーを送信します。 ブラインドコピーとは、他の受信者から隠されているメールアドレスのことです。
Subject パラメーターは、オプションの Body パラメーターが含まれていないため、メッセージです。
Credential パラメーターは、ドメイン管理者の資格情報を使用してメッセージを送信することを指定します。 UseSsl パラメーターは、Secure Socket Layer (SSL) がセキュリティで保護された接続を作成することを指定します。
パラメーター
-Attachments
電子メール メッセージに添付するファイルのパスとファイル名を指定します。 このパラメーターを使用するか、パスとファイル名をパイプ処理して Send-MailMessage
できます。
型: | String[] |
Aliases: | PsPath |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Bcc
メールのコピーを受信するが、メッセージの受信者としてリストされていない電子メールアドレスを指定します。 名前 (省略可能) と電子メール アドレス (Name <someone@fabrikam.com>
など) を入力します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Body
電子メール メッセージの内容を指定します。
型: | String |
配置: | 2 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BodyAsHtml
Body パラメーターの値に HTML が含まれていることを指定します。
型: | SwitchParameter |
Aliases: | BAH |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Cc
電子メール メッセージのカーボン コピー (CC) の送信先の電子メール アドレスを指定します。 名前 (省略可能) と電子メール アドレス (Name <someone@fabrikam.com>
など) を入力します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
このアクションを実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。
User01 や Domain01\User01などのユーザー名を入力します。 または、 コマンドレットのオブジェクトなど、Get-Credential
オブジェクトを入力します。
型: | PSCredential |
配置: | Named |
規定値: | Current user |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DeliveryNotificationOption
電子メール メッセージの配信通知オプションを指定します。 複数の値を指定できます。 既定値は None です。 このパラメーターのエイリアスは DNO です。
配信通知は、From パラメーターのアドレスに送信されます。
このパラメーターに使用できる値は次のとおりです。
- なし: 通知なし。
- OnSuccess: 配信が成功した場合は通知します。
- OnFailure: 配信が失敗した場合に通知します。
- 遅延: 配信が遅延した場合に通知します。
- Never: 通知しません。
型: | DeliveryNotificationOptions |
Aliases: | DNO |
指定可能な値: | None, OnSuccess, OnFailure, Delay, Never |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Encoding
ターゲット ファイルのエンコードの種類を指定します。 既定値は Defaultです。
このパラメーターに使用できる値は次のとおりです。
- ASCII ASCII (7 ビット) 文字セットを使用します。
- BigEndianUnicode では、ビッグ エンディアンバイト順で UTF-16 を使用します。
- 既定の システムのアクティブなコード ページ (通常は ANSI) に対応するエンコードを使用します。
- OEM システムの現在の OEM コード ページに対応するエンコードを使用します。
- Unicode では、リトル エンディアンバイト順で UTF-16 が使用されます。
- UTF7
UTF-7 を使用します。 - UTF8 は UTF-8 を使用します。
- UTF32 では、リトル エンディアンバイト順で UTF-32 が使用されます。
型: | Encoding |
Aliases: | BE |
指定可能な値: | ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32 |
配置: | Named |
規定値: | Default |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-From
From パラメーターが必要です。 このパラメーターは、送信者のメール アドレスを指定します。 名前 (省略可能) と電子メール アドレス (Name <someone@fabrikam.com>
など) を入力します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Port
SMTP サーバー上の代替ポートを指定します。 既定値は 25 で、これは既定の SMTP ポートです。
型: | Int32 |
配置: | Named |
規定値: | 25 |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Priority
電子メール メッセージの優先順位を指定します。 既定値は標準です。 このパラメーターに使用できる値は、Normal、High、Low です。
型: | MailPriority |
指定可能な値: | Normal, High, Low |
配置: | Named |
規定値: | Normal |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SmtpServer
電子メール メッセージを送信する SMTP サーバーの名前を指定します。
既定値は、$PSEmailServer
ユーザー設定変数の値です。 preference 変数が設定されておらず、このパラメーターが使用されていない場合、 Send-MailMessage
コマンドは失敗します。
型: | String |
Aliases: | ComputerName |
配置: | 3 |
規定値: | $PSEmailServer |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Subject
Subject パラメータは必須です。 このパラメーターは、電子メール メッセージの件名を指定します。
型: | String |
Aliases: | sub |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-To
To パラメーターが必要です。 このパラメーターは、受信者のメール アドレスを指定します。 受信者が複数いる場合は、アドレスをカンマ(,
)で区切ります。 名前 (省略可能) と電子メール アドレス (Name <someone@fabrikam.com>
など) を入力します。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UseSsl
Secure Sockets Layer (SSL) プロトコルは、メールを送信するリモート コンピューターへのセキュリティで保護された接続を確立するために使用されます。 既定では、SSL は使用されません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
添付ファイルのパスとファイル名を Send-MailMessage
にパイプできます。
出力
None
このコマンドレットは出力を生成しません。