- Inheritance
- < URI::Generic < Object
- Included Modules
- REGEXP
RFC2368, The mailto URL scheme
Constants
| Name | Description | |
|---|---|---|
| COMPONENT | = [ :scheme, :to, :headers ].freeze | |
| DEFAULT_PORT | = nil |
Attributes
| Name | Visibility | R/W | Description |
|---|---|---|---|
| headers | public | R | E-mail headers set by the URL, as an Array of Arrays |
| to | public | R | The primary e-mail address of the URL, as a String |
Methods
Class
| Visibility | Signature |
|---|---|
| public | build (args) |
| public | new (*arg) |
Instance
| Visibility | Signature |
|---|---|
| public | headers= (v) |
| public | to= (v) |
| public | to_mailtext () |
| public | to_rfc822text () |
| public | to_s () |
| protected | set_headers (v) |
| protected | set_to (v) |
Class Method Detail
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(['joe@example.com', 'subject=Ruby'])
puts m1.to_s -> mailto:joe@example.com?subject=Ruby
m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
puts m2.to_s -> mailto:john@example.com?Subject=Ruby&Cc=jack@example.com
m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
puts m3.to_s -> mailto:listman@example.com?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.
Instance Method Detail
headers=(v)
to=(v)
to_mailtext()
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"
to_rfc822text()
Alias for to_mailtext