class Net::IMAP::AppendUIDData

NOTE: AppendUIDData will replace UIDPlusData for APPENDUID in the 0.6.0 release. To use AppendUIDData before 0.6.0, set Config#parser_use_deprecated_uidplus_data to false.

AppendUIDData represents the ResponseCode#data that accompanies the APPENDUID response code.

A server that supports UIDPLUS (or IMAP4rev2) should send AppendUIDData inside every TaggedResponse returned by the append command—unless the target mailbox reports UIDNOTSTICKY.

Required capability¶ ↑

Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.

Attributes

assigned_uids [R]

A SequenceSet with the newly assigned UIDs of the appended messages.

uidvalidity [R]

:call-seq: uidvalidity -> nonzero uint32

The UIDVALIDITY of the destination mailbox.

Public Class Methods

new (uidvalidity:, assigned_uids:)

Source

# File lib/net/imap/uidplus_data.rb, line 84
def initialize(uidvalidity:, assigned_uids:)
  uidvalidity   = Integer(uidvalidity)
  assigned_uids = SequenceSet[assigned_uids]
  NumValidator.ensure_nz_number(uidvalidity)
  if assigned_uids.include_star?
    raise DataFormatError, "uid-set cannot contain '*'"
  end
  super
end

Calls superclass method

Public Instance Methods

size

Source

# File lib/net/imap/uidplus_data.rb, line 106
def size
  assigned_uids.count_with_duplicates
end

Returns the number of messages that have been appended.