class URI::MailTo

要約

mailto URI を表すクラスです。[RFC2368]。

継承しているメソッド

URI::Genericから継承しているメソッド

特異メソッド

build(ary) -> URI::MailTo[permalink][rdoc]

build(hash) -> URI::MailTo

引数で与えられた URI 構成要素から URI::MailTo オブジェクトを生成します。引数の正当性をチェックします。

[PARAM] ary:: 構成要素を [to, headers]

という文字列の配列で与えます。headers は、以下のような文字列か配列で与えます。

"subject=subscribe&cc=addr"

[["subject", "subscribe"], ["cc", "addr"]]

[PARAM] hash:: 構成要素をハッシュで与えます。ハッシュのキーは :to, :headers です。ハッシュの値は ary と同様です。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数に対して発生します。

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false) -> URI::MailTo[permalink][rdoc]

汎用的な構成要素から URI::MailTo オブジェクトを生成します。 build と異なり、デフォルトでは引数の正当性を検査しません。

[PARAM] scheme:: 構成要素を表す文字列を与えます。
[PARAM] userinfo:: 構成要素を表す文字列を与えます。
[PARAM] host:: 構成要素を表す文字列を与えます。
[PARAM] port:: 構成要素を表す文字列を与えます。
[PARAM] registry:: nil を与えます。
[PARAM] path:: 構成要素を表す文字列を与えます。
[PARAM] opaque:: 構成要素を表す文字列を与えます。
[PARAM] query:: 構成要素を表す文字列を与えます。
[PARAM] fragment:: 構成要素を表す文字列を与えます。
[PARAM] arg_check:: 真が与えられた場合は、各引数が字句規則に適合しているか否かを検査します。適合しない場合は例外 URI::InvalidComponentError が起ります。
[EXCEPTION] URI::InvalidURIError:: use_registry が偽のとき、registry が与えられると発生します。
[EXCEPTION] URI::InvalidComponentError:: 各要素が適合しない場合に発生します。

インスタンスメソッド

headers -> [[String]][permalink][rdoc]

自身のヘッダーを文字列の配列の配列として設定します。

例:

require 'uri'
m = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
p m.headers #=> [["subject", "subscribe"], ["cc", "myaddr"]]

headers=(s)[permalink][rdoc]

自身のヘッダーを文字列で設定します。

[PARAM] s:: ヘッダーを表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。

例:

require 'uri'
m = URI.parse("mailto:nospam@example.com")
m.headers =  URI.escape("subject=hello hello")

to -> String[permalink][rdoc]

自身の e-mail アドレスを文字列で返します。

例:

require 'uri'
p URI.parse("mailto:nospam@example.com").to     #=> "nospam@example.com"

to=(s)[permalink][rdoc]

自身の e-mail アドレスを文字列で設定します。

[PARAM] s:: 自身の e-mail アドレスを文字列で指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。

例:

require 'uri'
m = URI.parse("mailto:nospam@example.com")
m.to = "nospaaaam@example.com"
p m                                        #=> #<URI::MailTo:0xb7bf0614 URL:mailto:nospaaaam@example.com>

to_mailtext -> String[permalink][rdoc]

to_rfc822text -> String

URI オブジェクトからメールテキスト文字列を生成します。

例:

require 'uri'
p mailto = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
print mailto.to_mailtext

=> #<URI::MailTo:0x20104a0e URL:mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr>
   To: ruby-list@ruby-lang.org
   Subject: subscribe
   Cc: myaddr

class URI::MailTo

要約

目次

継承しているメソッド

特異メソッド

インスタンスメソッド