123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::VanishedData

Relationships & Source Files
Inherits: Object
Defined in: lib/net/imap/vanished_data.rb

Overview

VanishedData represents the contents of a VANISHED response, which is described by the QRESYNC extension. [RFC7162 §3.2.10].

VANISHED responses replace EXPUNGE responses when either the QRESYNC or the UIDONLY extension has been enabled.

Class Method Summary

Instance Method Summary

  • #each

    Yields each UID in #uids and returns self.

  • #to_a

    Returns an Array of all of the UIDs in #uids.

  • #earlier? Internal use only

    rdoc doesn’t handle attr aliases nicely.

Constructor Details

.new(uids:, earlier:) ⇒ VanishedData

Returns a new VanishedData object.

  • uids will be converted by SequenceSet.[].

  • earlier will be converted to true or false

[ GitHub ] 

  


# File 'lib/net/imap/vanished_data.rb', line 21



def initialize(uids:, earlier:)
  uids    = SequenceSet[uids] unless uids.equal? SequenceSet.empty
  earlier = !!earlier
  super
end


  







Instance Method Details



  

    #each  
  



  

    

Yields each UID in #uids and returns self.  Returns an Enumerator when no block is given.



See SequenceSet#each_number.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/vanished_data.rb', line 58



def each(&)
  return to_enum unless block_given?
  uids.each_number(&)
  self
end


  








  

    #earlier?  
  

  

    This method is for internal use only.
  



  

    

rdoc doesn’t handle attr aliases nicely. :(


  



  [ GitHub ]


  

  


# File 'lib/net/imap/vanished_data.rb', line 43



alias earlier? earlier # :nodoc:


  








  

    #to_a  
  



  

    

Returns an Array of all of the UIDs in #uids.



See SequenceSet#numbers.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/vanished_data.rb', line 52



def to_a; uids.numbers end