Sendmail
3.3.5 Sendmail
説明
Sendmail - 電子メールを送信します。このコマンドはSMTPクライアントとして動作し、SMTPサーバーを経由して電子メールを添付ファイルと共に送信します。電子メールを受信するにはMailコマンドを使用します。
サポートされている認証スキームは以下の通りです。ノーセキュリティ(公開/匿名メールサーバー)、プレーンユーザー/パスワード認証またはOAuth2認証は、GoogleまたはMicrosoft IMAPサーバー(6.2.3以降)に対して行われます。通信は暗号化されないか、STARTTLSで暗号化されます(4.1.3以降)。バージョン4.4.3では、SSLセキュアSMTP(通常はポート465)のサポートが導入されました。接続タイプはポートに基づいて自動的にピックアップされ、コマンドで指定する必要はありません。サーバーがカスタム・ポートを使用している場合は、コマンド環境設定でセキュリティ・タイプを手動で設定する必要があります。
オプションの添付ファイルはBase64エンコーディングで送信されます。
Sendmail の設定でfrom、to、server、user、passwdのデフォルト値が指定されている場合は、コマンドで省略できます。
SYNOPSIS
Sendmail [from=<sender_address>] [to=<recipient_address>] [server=<server[:port]>] [cc=<recipient_address>] [bcc=<recipient_address>] [subject=<subject>] [text=<mail_body>] [attach=<attachments>] [user=<userId>] [security=<none|password|google|microsoft>] [passwd=<password>] [delayed=<true|false>] [debug=<true|false>]
パラメータは、Sendmailの環境設定によって有効なデフォルト値が提供されない限り、必須です。
オプション
from=<送信者アドレス>
送信者の電子メールアドレス、またはコンマで区切られたアドレスのリスト。john.doe@company.com。
to=<受信者のアドレス(es)>
受信者の電子メールアドレス。jane.doe@company.com.
cc=<受信者のアドレス(es)>
カーボンコピー(CC)メールアドレス、またはカンマ区切りのアドレスリスト(5.0.3以降)。
bcc=<受信者のアドレス(es)>
ブラインドカーボンコピー(BCC)メールアドレス、またはカンマ区切りのアドレスリスト(5.0.3以降)。
server=<サーバー[:port]>
メール・メッセージを送信するSMTPサーバー。ポート番号なしでホスト名だけを使用した場合、コマンドは標準のSMTPポート25でサーバーへの接続を試みます。
security=<none|password|google|microsoft>
セキュリティタイプ:
“none” - 匿名アクセス
“password” - プレーンパスワード認証。パスワードはpasswordパラメータで指定できます。
“google” - GMail SMTP サーバーへの OAuth2 認証。
“microsoft” - MS Outlook SMTP サーバーへの OAuth2 認証。
OAuth2スキームのいずれかを有効にするには、認証トークンをツール→OAuthトークン・マネージャーウィンドウに表示されます。トークンの有効期限は長いですが、ユーザー側で無効にしたり(パスワードの変更、Google Dev ConsoleやMS Azureアカウントによる無効化など)、長期間(通常6ヶ月)使用しなかったりすると無効になります。ダウンロードされたトークンは暗号化され、Robotの設定ファイルに保存されます。
もしセキュリティパラメータが省略された場合のコマンドのデフォルトは "なし"または「パスワードパスワードが指定されているかどうかで、セキュリティが変わります。
passwd=<パスワード>
SMTPサーバーへの認証に使用するパスワード。セキュリティが “password” に設定されている場合にのみ使用されます。
subject=<件名>
メールの件名(タイトル)。
text=<メール本文>
メール本文。本文が"<html>"で始まる場合、コンテンツ・タイプはHTMLに設定されます。それ以外はプレーンテキストとして送信されます。改行を示すには'˶n'を使います。通常のテキストで' \n'を使用する必要がある場合は、バックスラッシュ文字(' \n')を2重にしてください。
attach=<添付ファイル>
電子メールに添付するファイルのリスト。ファイル名はセミコロン(';')で区切ってください。Linux/Unixでは、ファイル名にセミコロンが含まれていないことを確認してください。添付ファイルが見つからない場合は無視され、添付ファイルなしでメールが送信されます。添付ファイルは絶対パスで指定することをお勧めします。
user=<ユーザー名>
SMTP サーバに対して認証するユーザ ID。このオプションは、server パラメータで指定された SMTP サーバがプレーンパスワード認証を必要とする場合に、passwd パラメータと併用する必要があります。
delayed=<true|false>
trueを設定すると、電子メールはスクリプトが終了するまで遅延されます(4.1.3以降に対応)。これは、スクリプトがテスト結果(レポート)をメールで送信する必要があり、遅延なしで送信するとデータに「実行中」のステータスが表示される場合などに便利です。デフォルト値はfalse(直ちに送信)です。
debug=<true|false>
デバッグフラグ。debug=trueを使用すると、JavaMailのデバッグ・コンソール出力がオンになります。これは、電子メール機能が動作しない原因を突き止める必要がある場合に便利です。
戻り値
このコマンドは、成功すれば0(ゼロ)を返し、電子メールを送信できなければ1を返します。
使用例
Screenshot scr.png
Sendmail to="tester@dummyserver.com" from="robot@dummyserver.com" server="mail.dummyserver.com" subject="Screenshot of the remote desktop" text="Please check the attached screenshot."attach="{_REPORT_DIR}/scr.png"
現在のリモートデスクトップのスクリーンショットを撮影し、ユーザー tester@dummyserver.com に電子メールで送信します。
Sendmail subject="Hello" text="This is a multiline E-mail.\nSecond line.\nThird line."
複数行メールの例。このコマンドは、sendmailコマンドの環境設定で'from', 'to', 'server'パラメータのデフォルト値が正しく設定されている場合にのみ動作します。
Sendmail subject="HTML Example" text="<html><body><h1>Hi there!</h1>How are you?</body></html>"
HTMLメールの例このコマンドは、Sendmailコマンドの環境設定で、'from'、'to'、'server'パラメータのデフォルト値が正しく設定されている場合にのみ動作します。
Sendmail delayed="true" subject="Script finished" text="<html><body>Script <i>{_FILENAME}</i> finished with the exit code of {_EXIT_CODE}. See the results <a href=\"http://myserver.mydomain.com/reports/{_REPORT_FILE_RELATIVE}\">here</a>.</body></html>"
スクリプトの終了を通知するメールの例。delayed」パラメータがtrueに設定されているため、メールはスクリプトの終了後に送信されます。レポートディレクトリは、ホストmyserver.mydomain.com上のウェブサーバのドキュメントルート下のreports/フォルダにリンクされていると仮定します。また、簡単にするために、'より', 'への'と'サーバー'パラメーターはsendmailコマンドの環境設定にある。