Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > net/popライブラリ > Net::POPMailクラス

class Net::POPMail

クラスの継承リスト: Net::POPMail < Object < Kernel < BasicObject

Abstract

POP サーバー上のメール一通を表現するクラス。 メールの取得や消去といった操作をカプセル化します。

インスタンスメソッド

pop
all
mail

メールを受信して文字列で返します。

pop, all, mail はすべて同じ効果ですが、 all と mail は obsolete です。 これからは常に pop を使ってください。

使用例: 

require 'net/pop'

Net::POP3.start('your.pop3.server', 110,
                'YourAccount, 'YourPassword') {|pop|
  pop.mails.each do |m|
    puts m.pop
  end
}
pop {|str| .... }
all {|str| .... }
mail {|str| .... }

メールの文字列を少しずつ読みこみ、順次ブロックに与えます。

pop, all, mail はすべて同じ効果ですが、 all と mail は obsolete です。 これからは常に pop を使ってください。

使用例: 

require 'net/pop'

Net::POP3.start('localhost', 110) {|pop|
  pop.each_mail do |m|
    m.pop do |str|
      print str
    end
  end
}
delete
delete!

サーバ上からメールを削除します。

Ruby 1.8 以降では delete と delete! は同じ効果です。 また、delete! は obsolete なので、 これからは常に delete を使うべきです。

deleted?

メールがサーバ上で消去されていたら true を返します。

いったんメールを消去したら Net::POP3#reset を使う以外に復活する方法はありません。

header

ヘッダだけを受信して文字列で返します。

number

メールに対して振られた、そのメールボックスで一意な番号です。 サーバに接続しなおすとこの番号は変化する場合があります。 メールごとに一意な識別子が必要なときは Net::POPMail#uidl を使ってください。

size

メールのサイズ (単位はバイト) をかえします。

top(lines)

メールヘッダと lines 行ぶんの本文を取得し文字列で返します。

uidl
unique_id

メールに対して振られた、サーバ上で一意な識別子 (UIDL) をかえします。 Net::POPMail#number と違い、 この UIDL は接続しなおしても変化しません。

Methods

Classes