class Net::IMAP::VanishedData

Net::IMAP::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.

Attributes

earlier [R]

true when the response was caused by Net::IMAP#uid_fetch with vanished: true or Net::IMAP#select/Net::IMAP#examine with qresync: true.

false when the response is used to announce message removals within an already selected mailbox.

earlier? [R]

Alias for earlier.

uids [R]

SequenceSet of UIDs that have been permanently removed from the mailbox.

Public Class Methods

new (uids:, earlier:)

Source

# 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

Returns a new VanishedData object.

uids will be converted by SequenceSet.[].
earlier will be converted to true or false

Calls superclass method

Public Instance Methods

each (&)

Source

# File lib/net/imap/vanished_data.rb, line 58
def each(&)
  return to_enum unless block_given?
  uids.each_number(&)
  self
end

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

See SequenceSet#each_number.

to_a

Source

# File lib/net/imap/vanished_data.rb, line 52
def to_a; uids.numbers end

Returns an Array of all of the UIDs in uids.

See SequenceSet#numbers.