バージョン: 19

SMTPTransporter

SMTPTransporter クラスを使って、SMTP接続の設定や、SMTP transporter オブジェクトを介したメールの送信をおこなうことができます。

SMTP Transporter オブジェクト

SMTP Transporter オブジェクトは SMTP New transporter コマンドによってインスタンス化されます。これらは、次のプロパティや関数を持ちます:


.acceptUnsecureConnection : Boolean 暗号化されていない接続の確立が許可されてれば true を格納します
.authenticationMode : Text メールサーバーのセッションを開くのに使用される認証モードを格納します
.bodyCharset : Text メール本文で使用される文字セットとエンコーディングを格納します
.checkConnection() : Object transporter オブジェクトが保存する情報を使用して接続をチェックします
.connectionTimeOut : Integer サーバー接続の確立までに待機する最長時間 (秒単位) を格納します
.headerCharset : Text メールヘッダーで使用される文字セットとエンコーディングを格納します
.host : Text ホストサーバーの名前または IPアドレスを格納します
.keepAlive : Boolean `transporter` オブジェクトが抹消されるまで、SMTP接続が維持されなければならない場合に true を格納します
.logFile : Text メール接続に対して定義された拡張ログファイル (あれば) へのフルパスを格納します
.port : Integer メール通信に使用されるポート番号を格納します
.send( mail : Object ) : Object mail 引数が指定するメールメッセージを、`transporter` オブジェクトが定義する SMTPサーバーへと送信し、ステータスオブジェクトを返します
.sendTimeOut : Integer `.send()` 呼び出し時のタイムアウト時間 (秒単位)を格納します
.user : Text メールサーバーでの認証に使用されたユーザー名を格納します

SMTP New transporter

履歴

リリース	内容
18	logFile プロパティを追加
17 R5	bodyCharset と headerCharset プロパティを追加
17 R4	追加

SMTP New transporter( server : Object ) : 4D.SMTPTransporter

引数	型		説明
server	Object	->	メールサーバー情報
戻り値	4D.SMTPTransporter	<-	SMTP transporter オブジェクト

説明

SMTP New transporter コマンドは、新規の SMTP接続を設定します。この SMTP接続は、server 引数の指定に応じてを設定され、コマンドの戻り値は新しい SMTP transporter オブジェクトです。返された transporter オブジェクトは、通常メールの送信に使用されます。

このコマンドは SMTPサーバーとの接続を開始しません。 SMTP接続は、実際には .send() 関数が実行された時に開かれます。

SMTP接続は、以下の場合に自動的に閉じられます:

.keepAlive プロパティが true (デフォルト) の場合には、transporter オブジェクトが消去された時。

.keepAlive プロパティが false の場合には、各 .send( ) 関数が実行された後。

server 引数として、以下のプロパティを持つオブジェクトを渡します:

server	デフォルト値 (省略時)
.acceptUnsecureConnection : Boolean 暗号化されていない接続の確立が許可されてれば true を格納します	false
.accessTokenOAuth2: Text OAuth2 認証の資格情報を表すテキスト文字列。 `authenticationMode` が OAUTH2 の場合のみ使用されます。 `accessTokenOAuth2` が使用されているが `authenticationMode` が省略されていた場合、OAuth2 プロトコルが使用されます (サーバーで許可されていれば)。 SMTP transporter オブジェクトには返されません。	なし
.authenticationMode : Text メールサーバーのセッションを開くのに使用される認証モードを格納します	サーバーがサポートするもっともセキュアな認証モードが使用されます
.bodyCharset : Text メール本文で使用される文字セットとエンコーディングを格納します	`mail mode UTF8` (US-ASCII_UTF8_QP)
.connectionTimeOut : Integer サーバー接続の確立までに待機する最長時間 (秒単位) を格納します	30
.headerCharset : Text メールヘッダーで使用される文字セットとエンコーディングを格納します	`mail mode UTF8` (US-ASCII_UTF8_QP)
.host : Text ホストサーバーの名前または IPアドレスを格納します	必須
.keepAlive : Boolean `transporter` オブジェクトが抹消されるまで、SMTP接続が維持されなければならない場合に true を格納します	true
.logFile : Text メール接続に対して定義された拡張ログファイル (あれば) へのフルパスを格納します	なし
.password : Text サーバーとの認証のためのユーザーパスワード。 SMTP transporter オブジェクトには返されません。	なし
.port : Integer メール通信に使用されるポート番号を格納します	587
.sendTimeOut : Integer `.send()` 呼び出し時のタイムアウト時間 (秒単位)を格納します	100
.user : Text メールサーバーでの認証に使用されたユーザー名を格納します	なし

戻り値

この関数は、SMTP transporter オブジェクト を返します。返されるプロパティはすべて 読み取り専用 です。

例題

 $server:=New object
 $server.host:="smtp.gmail.com" // 必須
 $server.port:=465
 $server.user:="4D@gmail.com"
 $server.password:="XXXX"
 $server.logFile:="LogTest.txt" // Logsフォルダーに保存する拡張されたログ

 var $transporter : 4D.SMTPTransporter
 $transporter:=SMTP New transporter($server)

 $email:=New object
 $email.subject:="my first mail "
 $email.from:="4d@gmail.com"
 $email.to:="4d@4d.com;test@4d.com"
 $email.textBody:="Hello World"
 $email.htmlBody:="<h1>Hello World</h1><h4>'Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit...'</h4>\
 There are many variations of passages of Lorem Ipsum available."\
 +"The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.</p>"

 $status:=$transporter.send($email)
 If(Not($status.success))
    ALERT("メール送信中にエラーが発生しました: "+$status.message)
 End if

4D.SMTPTransporter.new()

4D.SMTPTransporter.new( server : Object ) : 4D.SMTPTransporter

引数	型		説明
server	Object	->	メールサーバー情報
戻り値	4D.SMTPTransporter	<-	SMTP transporter オブジェクト

説明

4D.SMTPTransporter.new() 関数は、 4D.SMTPTransporter 型の新しいオブジェクトを作成して返します。この関数の機能は、SMTP New transporter コマンドと同一です。

.acceptUnsecureConnection

履歴

リリース	内容
17 R4	追加

.acceptUnsecureConnection : Boolean

説明

.acceptUnsecureConnection プロパティは、暗号化されていない接続の確立が許可されてれば true を格納します (暗号化された接続が不可能な場合)。

暗号化されていない接続が許可されていない場合には false が格納されており、その場合に暗号化された接続が不可能な場合にはエラーが返されます。

使用可能なセキュアなポートは次のとおりです:

SMTP
- 465: SMTPS
- 587 または 25: STARTTLS アップグレードがされた SMTP (サーバーがサポートしていれば)
IMAP
- 143: IMAP 非暗号化ポート
- 993: STARTTLS アップグレードがされた IMAP (サーバーがサポートしていれば)
POP3
- 110: POP3 非暗号化ポート
- 995: STARTTLS アップグレードがされた POP3 (サーバーがサポートしていれば)

.authenticationMode

履歴

リリース	内容
17 R4	追加

.authenticationMode : Text

説明

.authenticationMode プロパティは、メールサーバーのセッションを開くのに使用される認証モードを格納します。

デフォルトでは、サーバーによってサポートされている最も安全なモードが使用されます。

とりうる値:

値	定数	説明
CRAM-MD5	`SMTP authentication CRAM MD5`	CRAM-MD5 プロトコルを使用した認証
LOGIN	`SMTP authentication login`	LOGIN プロトコルを使用した認証
OAUTH2	`SMTP authentication OAUTH2`	OAuth2 プロトコルを使用した認証
PLAIN	`SMTP authentication plain`	PLAIN プロトコルを使用した認証

.bodyCharset

履歴

リリース	内容
18	UTF8 base64 をサポート
17 R5	追加

.bodyCharset : Text

説明

.bodyCharset プロパティは、メール本文で使用される文字セットとエンコーディングを格納します。

とりうる値:

定数	値	説明
mail mode ISO2022JP	US-ASCII_ISO-2022-JP_UTF8_QP	headerCharset: 可能なら US-ASCII 、次に可能なら Japanese (ISO-2022-JP) & Quoted-printable 、それも不可なら UTF-8 & Quoted-printable bodyCharset: 可能なら US-ASCII、次に可能なら Japanese (ISO-2022-JP) & 7-bit、それも不可なら UTF-8 & Quoted-printable
mail mode ISO88591	ISO-8859-1	headerCharset: ISO-8859-1 & Quoted-printable bodyCharset: ISO-8859-1 & 8-bit
mail mode UTF8	US-ASCII_UTF8_QP	headerCharset & bodyCharset: 可能なら US-ASCII、それが不可なら UTF-8 & Quoted-printable (デフォルト値)
mail mode UTF8 in base64	US-ASCII_UTF8_B64	headerCharset & bodyCharset: 可能な場合は US-ASCII、それ以外は UTF-8 & base64

.checkConnection()

履歴

リリース	内容
17 R4	追加

.checkConnection() : Object

引数	型		説明
戻り値	Object	<-	transporter オブジェクト接続のステータス

説明

.checkConnection() 関数は、 transporter オブジェクトが保存する情報を使用して接続をチェックします。必要なら再接続をし、そのステータスを返します。この関数を使用して、ユーザーから提供された値が有効かどうかを検証することができます。

返されるオブジェクト

この関数はメールサーバーにリクエストを送信し、メールステータスを表すオブジェクトを返します。このオブジェクトには、次のプロパティが格納されることがあります:

プロパティ		型	説明
success		boolean	チェックが成功した場合には true、それ以外は false
status		number	(SMTPのみ) メールサーバーから返されたコード (メール処理に関係ない問題の場合には 0)
statusText		text	メールサーバーから返されたステータスメッセージ、または 4Dエラースタック内に返された最後のエラー
errors		collection	4Dエラースタック (メールサーバーレスポンスが受信できた場合には返されません)
	[ ].errCode	number	4Dエラーコード
	[ ].message	text	4Dエラーの詳細
	[ ].componentSignature	text	エラーを返した内部コンポーネントの署名

SMTPステータスコードについての詳細はこちらのページを参照ください。

例題

 var $pw : Text
 var $options : Object
 var $transporter : 4D.SMTPTransporter
 $options:=New object

 $pw:=Request("パスワードを入力してください:")
 $options.host:="smtp.gmail.com"

 $options.user:="test@gmail.com"
 $options.password:=$pw

 $transporter:=SMTP New transporter($options)

 $status:=$transporter.checkConnection()
 If($status.success=True)
    ALERT("SMTP接続チェックに成功しました。
 ")
 Else
    ALERT("エラー # "+String($status.status)+", "+$status.statusText)
 End if

.connectionTimeOut

履歴

リリース	内容
17 R5	追加

.connectionTimeOut : Integer

説明

.connectionTimeOut プロパティは、サーバー接続の確立までに待機する最長時間 (秒単位) を格納します。 SMTP New transporter や POP3 New transporter、 IMAP New transporter のコマンドで transporter オブジェクトを作成する際に使用される server オブジェクトにおいて、このプロパティが指定されなかった場合のデフォルトは 30 です。

.headerCharset

履歴

リリース	内容
17 R5	追加

.headerCharset : Text

説明

.headerCharset プロパティは、メールヘッダーで使用される文字セットとエンコーディングを格納します。ヘッダーにはメールの次の要素を含みます:

件名
添付ファイル名
メール名

とりうる値:

定数	値	説明
mail mode ISO2022JP	US-ASCII_ISO-2022-JP_UTF8_QP	headerCharset: 可能なら US-ASCII 、次に可能なら Japanese (ISO-2022-JP) & Quoted-printable 、それも不可なら UTF-8 & Quoted-printable bodyCharset: 可能なら US-ASCII、次に可能なら Japanese (ISO-2022-JP) & 7-bit、それも不可なら UTF-8 & Quoted-printable
mail mode ISO88591	ISO-8859-1	headerCharset: ISO-8859-1 & Quoted-printable bodyCharset: ISO-8859-1 & 8-bit
mail mode UTF8	US-ASCII_UTF8_QP	headerCharset & bodyCharset: 可能なら US-ASCII、それが不可なら UTF-8 & Quoted-printable (デフォルト値)
mail mode UTF8 in base64	US-ASCII_UTF8_B64	headerCharset & bodyCharset: 可能な場合は US-ASCII、それ以外は UTF-8 & base64

.host

履歴

リリース	内容
17 R5	追加

.host : Text

説明

.host プロパティは、ホストサーバーの名前または IPアドレスを格納します。この情報はメール通信 (SMTP、POP3、IMAP) に使用されます。

.keepAlive

履歴

リリース	内容
17 R4	追加

.keepAlive : Boolean

説明

.keepAlive プロパティは、 transporter オブジェクトが抹消されるまで、SMTP接続が維持されなければならない場合に true を格納します(それ以外は False)。 SMTP New transporter コマンドで transporter オブジェクトを作成する際に使用する server オブジェクトにおいて、 keepAlive プロパティが指定されなかった場合のデフォルトは true です。

SMTP接続は、以下の場合に自動的に閉じられます:

.keepAlive プロパティが true (デフォルト) の場合には、transporter オブジェクトが消去された時。
.keepAlive プロパティが false の場合には、各 .send( ) 関数が実行された後。

.logFile

履歴

リリース	内容
17 R5	追加

.logFile : Text

説明

.logFile プロパティは、メール接続に対して定義された拡張ログファイル (あれば) へのフルパスを格納します。パスは、カレント Logs フォルダーを基準とした相対パス、あるいは絶対パスを指定できます。

SET DATABASE PARAMETER コマンドで有効化される通常のログファイルとは異なり、拡張ログファイルはすべての送信されたメールの MIMEコンテンツを保存し、サイズ制限がありません。拡張ログファイルの詳細については、以下の章をそれぞれ参照ください:

SMTP 接続 - 4DSMTPLog.txt
POP3 接続 - 4DPOP3Log.txt
IMAP 接続 - 4DIMAPLog.txt

.port

履歴

リリース	内容
17 R4	追加

.port : Integer

説明

.port プロパティは、メール通信に使用されるポート番号を格納します。 SMTP New transporter や POP3 New transporter、 IMAP New transporter のコマンドで transporter オブジェクトを作成する際に使用される server オブジェクトにおいて、このプロパティが指定されなかった場合に使用されるポートは次のとおりです:

SMTP - 587
POP3 - 995
IMAP - 993

.send()

履歴

リリース	内容
17 R5	MIMEコンテンツをサポート
17 R4	追加

.send( mail : Object ) : Object

引数	型		説明
mail	Object	->	送信するメール
戻り値	Object	<-	SMTP ステータス

説明

.send() 関数は、 mail 引数が指定するメールメッセージを、transporter オブジェクトが定義する SMTPサーバーへと送信し、ステータスオブジェクトを返します。

transporter オブジェクトは、事前に SMTP New transporter コマンドによって作成されている必要があります。

この関数は、SMTP接続が事前に開かれていなかった場合には、それを作成します。 transporter オブジェクトの .keepAlive プロパティが false であった場合、SMTP接続は .send() 実行後に自動的に閉じられます。それ以外の場合には、接続は transporter オブジェクトが消去されるまで開いたままになります。詳細については、SMTP New transporter コマンドの説明を参照してください。

mailには、送信する有効な Email オブジェクトを渡します。メールには送信元 (メールがどこから送られるか) と送信先 (一名以上の受信者) プロパティが含まれている必要がありますが、その他のプロパティは任意です。

返されるオブジェクト

この関数は、SMTP ステータスを表すオブジェクトを返します。このオブジェクトには、次のプロパティが格納されることがあります:

プロパティ	型	説明
success	boolean	送信に成功した場合は true、それ以外は false
status	number	SMTPサーバーから返されたコード (メール処理に関係ない問題の場合には 0)
statusText	text	SMTPから返されるステータスメッセージ

SMTP 処理とは関係のない問題 (例: 必須プロパティがメールにない) が発生した場合、4D はエラーを生成します。これは、ON ERR CALL コマンドでインストールしたメソッドでインターセプトできます。エラー情報を取得するには、GET LAST ERROR STACK コマンドを使用します。

この場合、結果のステータスオブジェクトには以下の値が含まれます:

プロパティ	値
success	false
status	0
statusText	"Failed to send email"

.sendTimeOut

履歴

リリース	内容
17 R4	追加

.sendTimeOut : Integer

説明

.sendTimeOut プロパティは、 .send() 呼び出し時のタイムアウト時間 (秒単位)を格納します。 .sendTimeOut プロパティが server オブジェクトによって設定されていない場合は、デフォルトで 100 という値が使用されます。

.user

履歴

リリース	内容
17 R4	追加

.user : Text

説明

.user プロパティは、メールサーバーでの認証に使用されたユーザー名を格納します。