Class: Net::POPMail

Inherits:
Object
  • Object
show all
Defined in:
lib/net/pop_ssl.rb

Overview

This class represents a message which exists on the POP server. Instances of this class are created by the POP3 class; they should not be directly created by the user.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(num, len, pop, cmd) ⇒ POPMail

:nodoc:



714
715
716
717
718
719
720
721
 
# File 'lib/net/pop_ssl.rb', line 714

def initialize(num, len, pop, cmd)   #:nodoc:
  @number = num
  @length = len
  @pop = pop
  @command = cmd
  @deleted = false
  @uid = nil
end

Instance Attribute Details

#length ⇒ Object (readonly) Also known as: size

The length of the message in octets.



727
728
729
 
# File 'lib/net/pop_ssl.rb', line 727

def length
  @length
end

#number ⇒ Object (readonly)

The sequence number of the message on the server.



724
725
726
 
# File 'lib/net/pop_ssl.rb', line 724

def number
  @number
end

Instance Method Details

#delete ⇒ Object Also known as: delete!

Marks a message for deletion on the server. Deletion does not actually occur until the end of the session; deletion may be cancelled for all marked messages by calling POP3#reset().

This method raises a POPError if an error occurs.

Example

POP3.start('pop.example.com', 110,
           'YourAccount, 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      f.write popmail.pop
    end
    popmail.delete         ####
    n += 1
  end
end



829
830
831
832
 
# File 'lib/net/pop_ssl.rb', line 829

def delete
  @command.dele @number
  @deleted = true
end

#deleted? ⇒ Boolean

True if the mail has been deleted.

Returns:

  • (Boolean) 


837
838
839
 
# File 'lib/net/pop_ssl.rb', line 837

def deleted?
  @deleted
end

#header(dest = '') ⇒ Object

Fetches the message header.

The optional dest argument is obsolete.

This method raises a POPError if an error occurs.



805
806
807
 
# File 'lib/net/pop_ssl.rb', line 805

def header(dest = '')
  top(0, dest)
end

#inspect ⇒ Object

Provide human-readable stringification of class state.



731
732
733
 
# File 'lib/net/pop_ssl.rb', line 731

def inspect
  "#<#{self.class} #{@number}#{@deleted ? ' deleted' : ''}>"
end

#pop(dest = '', &block) ⇒ Object Also known as: all, mail

This method fetches the message. If called with a block, the message is yielded to the block one chunk at a time. If called without a block, the message is returned as a String. The optional dest argument will be prepended to the returned String; this argument is essentially obsolete.

Example without block

POP3.start('pop.example.com', 110,
           'YourAccount, 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      f.write popmail.pop              
    end
    popmail.delete
    n += 1
  end
end

Example with block

POP3.start('pop.example.com', 110,
           'YourAccount, 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      popmail.pop do |chunk|            ####
        f.write chunk
      end
    end
    n += 1
  end
end

This method raises a POPError if an error occurs.



773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/net/pop_ssl.rb', line 773

def pop( dest = '', &block ) # :yield: message_chunk
  if block_given?
    @command.retr(@number, &block)
    nil
  else
    @command.retr(@number) do |chunk|
      dest << chunk
    end
    dest
  end
end

#top(lines, dest = '') ⇒ Object

Fetches the message header and lines lines of body.

The optional dest argument is obsolete.

This method raises a POPError if an error occurs.



793
794
795
796
797
798
 
# File 'lib/net/pop_ssl.rb', line 793

def top(lines, dest = '')
  @command.top(@number, lines) do |chunk|
    dest << chunk
  end
  dest
end

#uid=(uid) ⇒ Object

:nodoc: internal use only



853
854
855
 
# File 'lib/net/pop_ssl.rb', line 853

def uid=(uid)   #:nodoc: internal use only
  @uid = uid
end

#unique_id ⇒ Object Also known as: uidl

Returns the unique-id of the message. Normally the unique-id is a hash string of the message.

This method raises a POPError if an error occurs.



845
846
847
848
849
 
# File 'lib/net/pop_ssl.rb', line 845

def unique_id
  return @uid if @uid
  @pop.set_all_uids
  @uid
end