123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::AppendUIDData

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Data_define__uidvalidity___assigned_uids_
Instance Chain:
self, Data_define__uidvalidity___assigned_uids_
Inherits: Net::IMAP::Data_define__uidvalidity___assigned_uids_
Defined in: lib/net/imap/uidplus_data.rb

Overview

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.

Class Method Summary

Data_define__uidvalidity___assigned_uids_ - Inherited

.[], .new

Instance Attribute Summary

Data_define__uidvalidity___assigned_uids_ - Inherited

#assigned_uids

:no-doc:
#uidvalidity

:no-doc:

Instance Method Summary

  • #size

    Returns the number of messages that have been appended.

Data_define__uidvalidity___assigned_uids_ - Inherited

#==, #eql?, #hash, #initialize

Constructor Details

.new(uidvalidity:, assigned_uids:) ⇒ AppendUIDData

[ GitHub ] 

  


# File 'lib/net/imap/uidplus_data.rb', line 122



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


  







Instance Method Details



  

    #size  
  



  

    

Returns the number of messages that have been appended.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/uidplus_data.rb', line 144



def size
  assigned_uids.count_with_duplicates
end