IMAPTransporter
IMAPTransporter
クラスを使って、IMAP メールサーバーからメッセージを取得することができます。
IMAP Transporter オブジェクト
IMAP Transporter オブジェクトは IMP New transporter コマンドによってインスタンス化されます。 これらは、次のプロパティや関数を持ちます:
IMAP New transporter
履歴
リリース | 内容 |
---|---|
18 R4 | 追加 |
IMAP New transporter( server : Object ) : 4D.IMAPTransporter
引数 | 型 | 説明 | |
---|---|---|---|
server | Object | -> | メールサーバー情報 |
戻り値 | 4D.IMAPTransporter | <- | IMAP transporter オブジェクト |
|
説明
IMAP New transporter
コマンドは、 新規の IMAP接続を設定します 。この IMAP接続は、server 引数の指定に応じてを設定され、コマンドの戻り値は新しい IMAP transporter オブジェクトです。 返される transporter オブジェクトは通常、メールの受信に使用されます。
server 引数として、以下のプロパティを持つオブジェクトを渡します:
server | デフォルト値 (省略時) |
---|---|
.acceptUnsecureConnection : Boolean 暗号化されていない接続の確立が許可されてれば true を格納します | false |
.accessTokenOAuth2: Text .accessTokenOAuth2: Object OAuth2 認証の資格情報を表すテキスト文字列またはトークンオブジェクト。 authenticationMode が OAUTH2 の場合のみ使用されます。 accessTokenOAuth2 が使用されているが authenticationMode が省略されていた場合、OAuth2 プロトコルが使用されます (サーバーで許可されていれば)。 IMAP transporter オブジェクトには返されません。 | なし |
.authenticationMode : Text メールサーバーのセッションを開くのに使用される認証モードを格納します | サーバーがサポートするもっともセキュアな認証モードが使用されます |
.checkConnectionDelay : Integer サーバー接続をチェックするまでの最長時間 (秒単位) を格納します | 300 |
.connectionTimeOut : Integer サーバー接続の確立までに待機する最長時間 (秒単位) を格納します | 30 |
.host : Text ホストサーバーの名前または IPアドレスを格納します | 必須 |
.logFile : Text メール接続に対して定義された拡張ログファイル (あれば) へのフルパスを格納します | なし |
.password : Text サーバーとの認証のためのユーザーパスワード。 IMAP transporter オブジェクトには返されません。 | なし |
.port : Integer メール通信に使用されるポート番号を格納します | 993 |
.user : Text メールサーバーでの認証に使用されたユーザー名を格納します | なし |
警告: 定義されたタイムアウトが、サーバータイムアウトより短いようにしてください。そうでない場合、クライアントタイムアウトは無意味になります。
戻り値
この関数は、IMAP transporter オブジェクト を返します。 返されるプロパティはすべて 読み取り専用 です。
IMAP接続は、transporter オブジェクトが消去された時点で自動的に閉じられます。
例題
$server:=New object
$server.host:="imap.gmail.com" // 必須
$server.port:=993
$server.user:="4d@gmail.com"
$server.password:="XXXXXXXX"
$server.logFile:="LogTest.txt" // Logsフォルダーに保存するログファイル
var $transporter : 4D.IMAPTransporter
$transporter:=IMAP New transporter($server)
$status:=$transporter.checkConnection()
If(Not($status.success))
ALERT("エラーが発生しました: "+$status.statusText)
End if
4D.IMAPTransporter.new()
4D.IMAPTransporter.new( server : Object ) : 4D.IMAPTransporter
引数 | 型 | 説明 | |
---|---|---|---|
server | Object | -> | メールサーバー情報 |
戻り値 | 4D.IMAPTransporter | <- | IMAP transporter オブジェクト |
|
説明
4D.IMAPTransporter.new()
関数は、 4D.IMAPTransporter
型の新しいオブジェクトを作成して返します. この関数の機能は、IMAP New transporter
コマンドと同一です。