Mail

説明

SMTP Eメールを送るタスク。

このタスクは、利用可能なものに依存して、 プレーンテキスト、UUエンコード、MIME形式のメールのいずれかを用いてメールを送ることができます。


SMTP auth and SSL/TLS require JavaMail and are only available in MIME format. SMTP認証とSSL/TLSはJavaMailとMIMEフォーマットでの利用が必要です。

添付ファイルは fileset 要素をネストすることにより送ります。

注意: このタスクは、Ant のディストリビューションには含まれていない外部ライブラリに依存します。 詳しくは、 ライブラリ依存関係をご覧ください。

パラメータ

属性 説明 必須
from 送信者のEメールアドレス from属性か、<from>要素のどちらか一方
replyto 返信Eメールアドレス No
tolist カンマで区切られた受取人のリスト 少なくともこれら、あるいはその等価な要素のうちの一つ
cclist カンマで区切られたカーボンコピーのための受取人のリスト
bcclist カンマで区切られたカーボンコピーのための受取人のリスト
message Eメールの本文として送るメッセージ これらのうち一つか、あるいは、 <message>要素
messagefile Eメールの本文として送るファイル。 ファイル中のプロパティの値は展開されます。
messagemimetype メッセージのコンテンツタイプ。 デフォルトはtext/plain No
files Eメールで添付ファイルとして送るファイル。 複数のファイルはカンマかスペースを使って区切ります。 ファイルを指定するには、 <fileset>要素も使えます。 No
failonerror 何らかのエラーでビルドを停止させるかを示すフラグ。 デフォルトはtrue No.
includefilenames ファイルコンテンツのまえに幾つかのファイルを挿入します。 plainエンコーディングが使われている時のみ有効です。 デフォルト値はfalseです。 No
mailhost SMTPサーバーのホスト名。 デフォルト値はlocalhost No
mailport SMTPサーバーのTCPポート。 デフォルト値は25 No
user SMTP認証のためのユーザ名 Yes, もしSMTPサーバ上でSMTP認証が必要ならば
Eメールメッセージは、MIMEを使って送り、JavaMailを必要としてます。
password SMTP認証のためのパスワード Yes, もしSMTPサーバ上でSMTP認証が必要ならば
Eメールメッセージは、MIMEを使って送り、JavaMailを必要としてます。
ssl ここでは、"true","on"又は"yes"が認められます。
TLS/SSLを必要とするかどうかを示します
No
encoding Eメールコンテンツのために使うべきエンコードを指定します。 値は、mime, uu, plain, 又は、 auto. デフォルト値は、auto uu又はplainは、SMTP認証に合っていません。 No
charset Eメールのキャラクタセット
ネストしたメッセージ要素と同様に、キャラクタセットを設定することができます。
これらのオプションは相互に排他的です。
No
subject Eメールの件名の行 No

Eメールアドレスを含んでいる属性に関連して注意してください。

Ant 1.6から、属性from, replyto, tolist, cclist, bcclistは、 フォームのEメールアドレスを含むことができます。

XMLエンティティとしてかぎ括弧(&gt;&lt;)を入力する必要があります。

ネストする要素として指定されるパラメータ

to / cc / bcc / from/ replyto

メールアドレス要素を加えます。次の属性を取ります:

属性 説明 必須
name アドレスの表示名 No
address Eメールアドレス Yes

message

Eメールの本文に含めるメッセージを指定します。 次の属性を取ります:

属性 説明 必須
src メッセージとして使われるファイル No
mimetype メッセージに使われるコンテンツタイプ No
charset メッセージのキャラクタセット
同封したメールタスクの属性と同様に、キャラクタセットを設定することができます。
これらのオプションは相互に排他的です。
No

src 属性が指定されない場合、 テキストは<message>要素により加えることができます。 外部ファイルとして指定されても、 <message>要素の中のテキストでも、どちらでも、 messageの中でプロパティの展開は行われます。

<mail from="me"
      tolist="you"
      subject="Results of nightly build"
      files="build.log"/>
me から you へ、 Results of nightly buildという件名で、 build.logファイルの中身をメッセージの本文に入れて、 メールを送ります。

<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
  <from address="config@myisp.com"/>
  <replyto address="me@myisp.com"/>
  <to address="all@xyz.com"/>
  <message>The ${buildname} nightly build has completed</message>
  <fileset dir="dist">
    <includes name="**/*.zip"/>
  </fileset>
</mail>

me@myisp.com から all@xyz.com へ、 Test Build という件名で、メールを送ります。 このメールを返信すると、me@myisp.comに行きます。 ディレクトリ dist の下の全ての zip ファイルを添付します。 このタスクは JavaMail を使い、 どのサポートするクラスが利用可能かその順序に依存して、UUエンコーディングあるいはエンコード無しとなります。 ${buildname}buildnameプロパティの値で置き換えられます。

<property name="line2" value="some_international_message"/>
<echo message="${line2}"/>

<mail mailhost="somehost@xyz.com" mailport="25" subject="Test build"  charset="utf-8">
  <from address="me@myist.com"/>
  <to address="all@xyz.com" />
  <message>some international text:${line2}</message>
</mail>

me@myisp.com から all@xyz.com へ、 Test Build という件名で、メールを送ります。 メッセージボディは、UTF-8で符号化されます。


Copyright © 2000-2004 The Apache Software Foundation. All rights Reserved.

[訳注:これは漆島賢二の訳を参考に、横田聡が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]