123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::UIDPlusData

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Struct
Instance Chain:
self, Struct
Inherits: Struct
  • Object
Defined in: lib/net/imap/response_data.rb

Overview

UIDPlusData represents the ResponseCode#data that accompanies the APPENDUID and COPYUID response codes.

A server that supports UIDPLUS should send a UIDPlusData object inside every TaggedResponse returned by the append, copy, move, uid copy, and uid move commands—unless the destination mailbox reports UIDNOTSTICKY.

Required capability

Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#assigned_uids (rw)

UIDPlusData represents the ResponseCode#data that accompanies the APPENDUID and COPYUID response codes.

A server that supports UIDPLUS should send a UIDPlusData object inside every TaggedResponse returned by the append, copy, move, uid copy, and uid move commands—unless the destination mailbox reports UIDNOTSTICKY.

Required capability

Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.

[ GitHub ] 

  


# File 'lib/net/imap/response_data.rb', line 361



class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)


  








  

    #source_uids   (rw)
  



  

    

UIDPlusData represents the ResponseCode#data that accompanies the APPENDUID and COPYUID response codes.



A server that supports UIDPLUS should send a UIDPlusData object inside every TaggedResponse returned by the append, copy, move, uid copy, and uid move commands—unless the destination mailbox reports UIDNOTSTICKY.



Required capability



Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 361



class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)


  








  

    #uidvalidity   (rw)
  



  

    

UIDPlusData represents the ResponseCode#data that accompanies the APPENDUID and COPYUID response codes.



A server that supports UIDPLUS should send a UIDPlusData object inside every TaggedResponse returned by the append, copy, move, uid copy, and uid move commands—unless the destination mailbox reports UIDNOTSTICKY.



Required capability



Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 361



class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)


  







Instance Method Details



  

    #uid_mapping  ⇒ nil, a hash   



  

    

Returns a hash mapping each source UID to the newly assigned destination UID.


Note




Returns nil for Net::IMAP#append.




  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 391



def uid_mapping
  source_uids&.zip(assigned_uids)&.to_h
end