123456789_123456789_123456789_123456789_123456789_

Class: Net::POPMail

Relationships & Source Files
Inherits: Object
Defined in: lib/net/pop.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.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(num, len, pop, cmd) ⇒ POPMail

This method is for internal use only.
[ GitHub ] 

  


# File 'lib/net/pop.rb', line 743



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


  







Instance Attribute Details



  

    #deleted?  ⇒ Boolean  (readonly)
  



  

    

True if the mail has been deleted.


  





  


  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 866



def deleted?
  @deleted
end


  








  

    #length   (readonly)
    Also known as: #size
  



  

    

The length of the message in octets.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 756



attr_reader :length


  








  

    #number   (readonly)
  



  

    

The sequence number of the message on the server.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 753



attr_reader :number


  








  

    #size   (readonly)
  



  

    

Alias for #length.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 757



alias size length


  








  

    #uid=(uid)   (writeonly)
  

  

    This method is for internal use only.
  



  

    

internal use only


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 882



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


  







Instance Method Details



  

    #all(dest = +'',, &block)  
  

  

    This method is for internal use only.
  



  

    

Alias for #pop.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 814



alias all pop    #:nodoc: obsolete


  








  

    #delete  
    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


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 858



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


  








  

    #delete!  
  

  

    This method is for internal use only.
  



  

    

Alias for #delete.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 863



alias delete! delete    #:nodoc: obsolete


  








  

    #header(dest = +''))  
  



  

    

Fetches the message header.



The optional dest argument is obsolete.



This method raises a POPError if an error occurs.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 834



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


  








  

    #inspect  
  



  

    

Provide human-readable stringification of class state.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 760



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


  








  

    #mail(dest = +'',, &block)  
  

  

    This method is for internal use only.
  



  

    

Alias for #pop.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 815



alias mail pop   #:nodoc: obsolete


  








  

    #pop(dest = +'',, &block)  
    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.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 802



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 = +''))  
  



  

    

Fetches the message header and lines lines of body.



The optional dest argument is obsolete.



This method raises a POPError if an error occurs.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 822



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


  








  

    #uidl  
  



  

    

Alias for #unique_id.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 880



alias uidl unique_id


  








  

    #unique_id  
    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.


  



  [ GitHub ]


  

  


# File 'lib/net/pop.rb', line 874



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