このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。 最新版のマニュアルへ

Ruby 3.1 リファレンスマニュアル

singleton method Net::FTP.new

new(host = nil, options = {}) -> Net::FTP[permalink][rdoc][edit]
new(host = nil, user = nil, passwd = nil, acct = nil) -> Net::FTP

新しい Net::FTP のインスタンスを生成します。

host が指定された場合、生成されたインスタンスに対して Net::FTP#connect を呼び出し、さらにログインユーザ名が指定された場合は Net::FTP#login を呼び出します。

2 番目の引数には、後方互換のためログインに使うユーザ名を表す文字列をそのまま渡すこともできますが、各キーがシンボルであるオプションのハッシュを渡すこともできます。オプションのハッシュを渡した場合、3 番目・4 番目の引数(passwd、acct)は無視され、ユーザ名やパスワードはオプションの :username、:password で指定します。

[PARAM] host:
接続するホストを指定します。
[PARAM] options:
オプションをハッシュで指定します。各キーはシンボルです。
:port

接続するポート番号を指定します。デフォルトは 21 です。

:ssl

真を指定すると SSL(TLS)を使った接続を試みます。ハッシュを指定した場合は OpenSSL::SSL::SSLContext#set_params にそのままパラメータとして渡されます。

:private_data_connection

真ならばデータ転送用のコネクションにも TLS を使います。 :ssl が真のときのデフォルトは true です。:ssl が偽のときに true を指定すると ArgumentError が発生します。

:username

ログインに使うユーザ名を指定します。

:password

ログインに使うパスワードを指定します。

:account

ログイン後に送る ACCT コマンドのパラメータを指定します。

:passive

真ならば接続をパッシブモードにします。デフォルトは true です (既定値は Net::FTP.default_passive= で変更できます)。

:open_timeout

接続の確立を待つ秒数を指定します。デフォルトは nil (タイムアウトなし) です。

:read_timeout

1 ブロックの読み込みを待つ秒数を指定します。デフォルトは 60 です。

:ssl_handshake_timeout

TLS のハンドシェイクを待つ秒数を指定します。デフォルトは nil です。

:use_pasv_ip

真ならば PASV 応答に含まれる IP アドレスを使用します。偽の場合は制御コネクションと同じ IP アドレスを使用します。デフォルトは false です。

:debug_mode

真ならば全ての通信内容を $stdout に出力します。デフォルトは false です。

[PARAM] user:
ログインに使うユーザ名を指定します(後方互換のための位置引数です)。
[PARAM] passwd:
ログインに使うパスワードを指定します(後方互換のための位置引数です)。
[PARAM] acct:
ログイン後に送る ACCT コマンドのパラメータを指定します(後方互換のための位置引数です)。

[SEE_ALSO] Net::FTP.open