Class URI::MailTo
In: lib/uri/mailto.rb
Parent: Generic

RFC2368, The mailto URL scheme

Methods

build   headers=   new   set_headers   set_to   to=   to_mailtext   to_rfc822text   to_s  

Included Modules

REGEXP

Constants

DEFAULT_PORT = nil
COMPONENT = [ :scheme, :to, :headers ].freeze

Attributes

headers  [R]  E-mail headers set by the URL, as an Array of Arrays
to  [R]  The primary e-mail address of the URL, as a String

Public Class methods

build(args)

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(['[email protected]', 'subject=Ruby'])
   puts m1.to_s  ->  mailto:[email protected]?subject=Ruby

   m2 = URI::MailTo.build(['[email protected]', [['Subject', 'Ruby'], ['Cc', '[email protected]']]])
   puts m2.to_s  ->  mailto:[email protected]?Subject=Ruby&[email protected]

   m3 = URI::MailTo.build({:to => '[email protected]', :headers => [['subject', 'subscribe']]})
   puts m3.to_s  ->  mailto:[email protected]?subject=subscribe
new(*arg)

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.

Public Instance methods

to_mailtext()

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

Example: 

  require 'uri'

  uri = URI.parse("mailto:[email protected]?Subject=subscribe&cc=myaddr")
  uri.to_mailtext
  # => "To: [email protected]\nSubject: subscribe\nCc: myaddr\n\n\n"
to_rfc822text()

Alias for to_mailtext

Protected Instance methods

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Rising Tide Software, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.