class Net::IMAP::UIDPlusData

NOTE: UIDPlusData is deprecated and will be removed in the 0.6.0 release. To use AppendUIDData and CopyUIDData before 0.6.0, set Config#parser_use_deprecated_uidplus_data to false.

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

A server that supports UIDPLUS should send UIDPlusData in response to the append, copy, move, uid copy, and uid move commands—unless the destination mailbox reports UIDNOTSTICKY.

Note that append, copy and uid_copy return UIDPlusData in their TaggedResponse. But move and uid_move should send UIDPlusData in an UntaggedResponse response before sending their TaggedResponse. However some servers do send UIDPlusData in the TaggedResponse for MOVE commands—this complies with the older UIDPLUS specification but is discouraged by the MOVE extension and disallowed by IMAP4rev2.

Required capability¶ ↑

Requires either UIDPLUS [RFC4315] or IMAP4rev2 capability.

Public Instance Methods

assigned_uids → an array of nonzero uint32

Source

# File lib/net/imap/uidplus_data.rb, line 48

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

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

source_uids → nil or an array of nonzero uint32

Source

# File lib/net/imap/uidplus_data.rb, line 40

The UIDs of the copied or moved messages.

Note	Returns `nil` for `Net::IMAP#append`.

uid_mapping → nil or a hash

Source

# File lib/net/imap/uidplus_data.rb, line 62
def uid_mapping
  source_uids&.zip(assigned_uids)&.to_h
end

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

Note	Returns `nil` for `Net::IMAP#append`.

uidvalidity → nonzero uint32

Source

# File lib/net/imap/uidplus_data.rb, line 34

The UIDVALIDITY of the destination mailbox.