class Net::IMAP::UIDPlusData

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

See [[UIDPLUS].

Capability requirement

The UIDPLUS capability must be supported. 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.

Public Instance Methods

assigned_uids → an array of nonzero uint32 click to toggle source

The newly assigned UIDs of the copied, moved, or appended messages.

Note

This always returns an array, even when it contains only one UID.

# File lib/net/imap/response_data.rb, line 362
      
source_uids → nil or an array of nonzero uint32 click to toggle source

The UIDs of the copied or moved messages.

Note

Returns nil for Net::IMAP#append.

# File lib/net/imap/response_data.rb, line 354
      
uid_mapping → nil or a hash click to toggle source

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

Note

Returns nil for Net::IMAP#append.

# File lib/net/imap/response_data.rb, line 376
def uid_mapping
  source_uids&.zip(assigned_uids)&.to_h
end
uidvalidity → nonzero uint32 click to toggle source

The UIDVALIDITY of the destination mailbox.

# File lib/net/imap/response_data.rb, line 348