FTP URI syntax is defined by RFC1738 section 3.2.

This class will be redesigned because of difference of implementations; the structure of its path. draft-hoffman-ftp-uri-04 is a draft but it is a good summary about the de facto spec.


A Default port of 21 for URI::FTP

An Array of the available components for URI::FTP

Typecode is “a”, “i” or “d”.

  • “a” indicates a text file (the FTP command was ASCII)

  • “i” indicates a binary file (FTP command IMAGE)

  • “d” indicates the contents of a directory should be displayed

Typecode prefix


typecode accessor


Class Methods


Creates a new URI::FTP object from components, with syntax checking.

The components accepted are userinfo, host, port, path and typecode.

The components should be provided either as an Array, or as a Hash with keys formed by preceding the component names with a colon.

If an Array is used, the components must be passed in the order

userinfo, host, port, path, typecode

If the path supplied is absolute, it will be escaped in order to make it absolute in the URI. Examples:

require 'uri'

uri =['user:password', '', nil,
  '/path/', 'i'])
puts uri.to_s  ->;type=i

uri2 ={:host => '',
  :path => 'ruby/src'})
puts uri2.to_s  ->


Creates a new URI::FTP object from generic URL components with no syntax checking.

Unlike build(), this method does not escape the path component as required by RFC1738; instead it is treated as per RFC2396.

Arguments are scheme, userinfo, host, port, registry, path, opaque, query and fragment, in that order.

Instance Methods

validates typecode v, returns a true or false boolean

Returns the path from an FTP URI.

RFC 1738 specifically states that the path for an FTP URI does not include the / which separates the URI path from the URI host. Example:

The above URI indicates that the client should connect to then cd pub/ruby from the initial login directory.

If you want to cd to an absolute directory, you must include an escaped / (%2F) in the path. Example:

This method will then return “/pub/ruby”

Private setter for the path of the URI::FTP

Private setter for the typecode v

see also URI::FTP.typecode=

Returns a String representation of the URI::FTP





public setter for the typecode v. (with validation)

see also URI::FTP.check_typecode


require 'uri'

uri = URI.parse("")
#=> #<URI::FTP:0x00000000923650 URL:>
uri.typecode = "i"
# =>  "i"
#=> #<URI::FTP:0x00000000923650 URL:;type=i>