RFC6068, the mailto URL scheme.

Constants

An Array of the available components for URI::MailTo.

A Default port of nil for URI::MailTo.

Attributes

E-mail headers set by the URL, as an Array of Arrays.

Read

The primary e-mail address of the URL, as a String.

Class Methods

Description

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

Components can be provided as an Array or Hash. If an Array is used, the components must be supplied as [to, headers].

If a Hash is used, the keys are the component names preceded by colons.

The headers can be supplied as a pre-encoded string, such as "subject=subscribe&cc=address", or as an Array of Arrays like [['subject', 'subscribe'], ['cc', 'address']].

Examples:

require 'uri'

m1 = URI::MailTo.build(['joe@example.com', 'subject=Ruby'])
m1.to_s  # => "mailto:joe@example.com?subject=Ruby"

m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
m2.to_s  # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"

m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
m3.to_s  # => "mailto:listman@example.com?subject=subscribe"

Description

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

This method is usually called from URI::parse, which checks the validity of each component.

Instance Methods

Checks the headers v component against either

  • HEADER_REGEXP

Checks the to v component.

Setter for headers v.

Private setter for headers v.

Private setter for to v.

Setter for to v.

Returns the RFC822 e-mail text equivalent of the URL, as a String.

Example:

require 'uri'

uri = URI.parse("mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
uri.to_mailtext
# => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"
An alias for to_mailtext

Constructs String from URI.