net-imap 0.4.12 → 0.5.5

data/lib/net/imap/response_data.rb

@@ -2,9 +2,12 @@
 
 module Net
   class IMAP < Protocol
+    autoload :ESearchResult,    "#{__dir__}/esearch_result"
     autoload :FetchData,        "#{__dir__}/fetch_data"
+    autoload :UIDFetchData,     "#{__dir__}/fetch_data"
     autoload :SearchResult,     "#{__dir__}/search_result"
     autoload :SequenceSet,      "#{__dir__}/sequence_set"
+    autoload :VanishedData,     "#{__dir__}/vanished_data"
 
     # Net::IMAP::ContinuationRequest represents command continuation requests.
     #
@@ -157,13 +160,20 @@ module Net
       # The raw response data.
     end
 
-    # Net::IMAP::ResponseText represents texts of responses.
+    # ResponseText represents texts of responses.
     #
     # The text may be prefixed by a ResponseCode.
     #
-    # ResponseText is returned from TaggedResponse#data, or from
-    # UntaggedResponse#data when the response type is a "condition" ("OK", "NO",
-    # "BAD", "PREAUTH", or "BYE").
+    # ResponseText is returned from TaggedResponse#data or
+    # UntaggedResponse#data for
+    # {"status responses"}[https://www.rfc-editor.org/rfc/rfc3501#section-7.1]:
+    # * every TaggedResponse, name[rdoc-ref:TaggedResponse#name] is always
+    #   "+OK+", "+NO+", or "+BAD+".
+    # * any UntaggedResponse when name[rdoc-ref:UntaggedResponse#name] is
+    #   "+OK+", "+NO+", "+BAD+", "+PREAUTH+", or "+BYE+".
+    #
+    # Note that these "status responses" are confusingly _not_ the same as the
+    # +STATUS+ UntaggedResponse (see IMAP#status and StatusData).
     class ResponseText < Struct.new(:code, :text)
       # Used to avoid an allocation when ResponseText is empty
       EMPTY = new(nil, "").freeze
@@ -181,32 +191,35 @@ module Net
       # Returns the response text, not including any response code
     end
 
-    # Net::IMAP::ResponseCode represents response codes.  Response codes can be
-    # retrieved from ResponseText#code and can be included in any "condition"
-    # response: any TaggedResponse and UntaggedResponse when the response type
-    # is a "condition" ("OK", "NO", "BAD", "PREAUTH", or "BYE").
+    # ResponseCode represents an \IMAP response code, which can be retrieved
+    # from ResponseText#code for
+    # {"status responses"}[https://www.rfc-editor.org/rfc/rfc3501#section-7.1]:
+    # * every TaggedResponse, name[rdoc-ref:TaggedResponse#name] is always
+    #   "+OK+", "+NO+", or "+BAD+".
+    # * any UntaggedResponse when name[rdoc-ref:UntaggedResponse#name] is
+    #   "+OK+", "+NO+", "+BAD+", "+PREAUTH+", or "+BYE+".
+    #
+    # Note that these "status responses" are confusingly _not_ the same as the
+    # +STATUS+ UntaggedResponse (see IMAP#status and StatusData).
     #
     # Some response codes come with additional data which will be parsed by
     # Net::IMAP.  Others return +nil+ for #data, but are used as a
     # machine-readable annotation for the human-readable ResponseText#text in
-    # the same response.  When Net::IMAP does not know how to parse response
-    # code text, #data returns the unparsed string.
+    # the same response.
     #
     # Untagged response code #data is pushed directly onto Net::IMAP#responses,
     # keyed by #name, unless it is removed by the command that generated it.
     # Use Net::IMAP#add_response_handler to view tagged response codes for
     # command methods that do not return their TaggedResponse.
     #
+    # == Standard response codes
+    #
     # \IMAP extensions may define new codes and the data that comes with them.
     # The IANA {IMAP Response
     # Codes}[https://www.iana.org/assignments/imap-response-codes/imap-response-codes.xhtml]
     # registry has links to specifications for all standard response codes.
-    # Response codes are backwards compatible:  Servers are allowed to send new
-    # response codes even if the client has not enabled the extension that
-    # defines them.  When unknown response code data is encountered, #data
-    # will return an unparsed string.
     #
-    # ==== +IMAP4rev1+ Response Codes
+    # === +IMAP4rev1+ response codes
     # See [IMAP4rev1[https://www.rfc-editor.org/rfc/rfc3501]] {§7.1, "Server
     # Responses - Status
     # Responses"}[https://www.rfc-editor.org/rfc/rfc3501#section-7.1] for full
@@ -237,24 +250,24 @@ module Net
     #   the <tt>\Seen</tt> flag set.
     #   <em>DEPRECATED by IMAP4rev2.</em>
     #
-    # ==== +BINARY+ extension
+    # === +BINARY+ extension
     # See {[RFC3516]}[https://www.rfc-editor.org/rfc/rfc3516].
     # * +UNKNOWN-CTE+, with a tagged +NO+ response, when the server does not
     #   known how to decode a CTE (content-transfer-encoding).  #data is +nil+.
     #   See IMAP#fetch.
     #
-    # ==== +UIDPLUS+ extension
+    # === +UIDPLUS+ extension
     # See {[RFC4315 §3]}[https://www.rfc-editor.org/rfc/rfc4315#section-3].
     # * +APPENDUID+, #data is UIDPlusData.  See IMAP#append.
     # * +COPYUID+, #data is UIDPlusData.  See IMAP#copy.
     # * +UIDNOTSTICKY+, #data is +nil+.  See IMAP#select.
     #
-    # ==== +SEARCHRES+ extension
+    # === +SEARCHRES+ extension
     # See {[RFC5182]}[https://www.rfc-editor.org/rfc/rfc5182].
     # * +NOTSAVED+, with a tagged +NO+ response, when the search result variable
     #   is not saved.  #data is +nil+.
     #
-    # ==== +RFC5530+ Response Codes
+    # === +RFC5530+ response codes
     # See {[RFC5530]}[https://www.rfc-editor.org/rfc/rfc5530], "IMAP Response
     # Codes" for the definition of the following response codes, which are all
     # machine-readable annotations for the human-readable ResponseText#text, and
@@ -277,22 +290,22 @@ module Net
     # * +ALREADYEXISTS+
     # * +NONEXISTENT+
     #
-    # ==== +QRESYNC+ extension
+    # === +QRESYNC+ extension
     # See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].
     # * +CLOSED+, returned when the currently selected mailbox is closed
     #   implicitly by selecting or examining another mailbox.  #data is +nil+.
     #
-    # ==== +IMAP4rev2+ Response Codes
+    # === +IMAP4rev2+ response codes
     # See {[RFC9051]}[https://www.rfc-editor.org/rfc/rfc9051] {§7.1, "Server
     # Responses - Status
     # Responses"}[https://www.rfc-editor.org/rfc/rfc9051#section-7.1] for full
     # descriptions of IMAP4rev2 response codes.  IMAP4rev2 includes all of the
-    # response codes listed above (except "UNSEEN") and adds the following:
+    # response codes listed above (except "+UNSEEN+") and adds the following:
     # * +HASCHILDREN+, with a tagged +NO+ response, when a mailbox delete failed
     #   because the server doesn't allow deletion of mailboxes with children.
     #   #data is +nil+.
     #
-    # ==== +CONDSTORE+ extension
+    # === +CONDSTORE+ extension
     # See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].
     # * +NOMODSEQ+, when selecting a mailbox that does not support
     #   mod-sequences.  #data is +nil+.  See IMAP#select.
@@ -302,10 +315,17 @@ module Net
     #   since the +UNCHANGEDSINCE+ mod-sequence given to +STORE+ or <tt>UID
     #   STORE</tt>.
     #
-    # ==== +OBJECTID+ extension
+    # === +OBJECTID+ extension
     # See {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html].
     # * +MAILBOXID+, #data is a string
     #
+    # == Extension compatibility
+    #
+    # Response codes are backwards compatible:  Servers are allowed to send new
+    # response codes even if the client has not enabled the extension that
+    # defines them.  When Net::IMAP does not know how to parse response
+    # code text, #data returns the unparsed string.
+    #
     class ResponseCode < Struct.new(:name, :data)
       ##
       # method: name
@@ -324,14 +344,9 @@ module Net
       # code data can take.
     end
 
-    # Net::IMAP::UIDPlusData represents the ResponseCode#data that accompanies
-    # the +APPENDUID+ and +COPYUID+ response codes.
-    #
-    # See [[UIDPLUS[https://www.rfc-editor.org/rfc/rfc4315.html]].
-    #
-    # ==== Capability requirement
+    # UIDPlusData represents the ResponseCode#data that accompanies the
+    # +APPENDUID+ and +COPYUID+ {response codes}[rdoc-ref:ResponseCode].
     #
-    # The +UIDPLUS+ capability[rdoc-ref:Net::IMAP#capability] must be supported.
     # A server that supports +UIDPLUS+ should send a UIDPlusData object inside
     # every TaggedResponse returned by the append[rdoc-ref:Net::IMAP#append],
     # copy[rdoc-ref:Net::IMAP#copy], move[rdoc-ref:Net::IMAP#move], {uid
@@ -339,9 +354,9 @@ module Net
     # move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the destination
     # mailbox reports +UIDNOTSTICKY+.
     #
-    #--
-    # TODO: support MULTIAPPEND
-    #++
+    # == Required capability
+    # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
+    # or +IMAP4rev2+ capability.
     #
     class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)
       ##
@@ -378,10 +393,8 @@ module Net
       end
     end
 
-    # Net::IMAP::MailboxList represents contents of the LIST response,
-    # representing a single mailbox path.
-    #
-    # Net::IMAP#list returns an array of MailboxList objects.
+    # MailboxList represents the data of an untagged +LIST+ response, for a
+    # _single_ mailbox path.  IMAP#list returns an array of MailboxList objects.
     #
     class MailboxList < Struct.new(:attr, :delim, :name)
       ##
@@ -391,11 +404,11 @@ module Net
       # Returns the name attributes. Each name attribute is a symbol capitalized
       # by String#capitalize, such as :Noselect (not :NoSelect).  For the
       # semantics of each attribute, see:
-      # * rdoc-ref:Net::IMAP@Basic+Mailbox+Attributes
-      # * rdoc-ref:Net::IMAP@Mailbox+role+Attributes
-      # * Net::IMAP@SPECIAL-USE
+      # * Net::IMAP@Basic+Mailbox+Attributes
+      # * Net::IMAP@Mailbox+role+Attributes
       # * The IANA {IMAP Mailbox Name Attributes
       #   registry}[https://www.iana.org/assignments/imap-mailbox-name-attributes/imap-mailbox-name-attributes.xhtml]
+      #   has links to specifications for all standard mailbox attributes.
 
       ##
       # method: delim
@@ -410,16 +423,16 @@ module Net
       # Returns the mailbox name.
     end
 
-    # Net::IMAP::MailboxQuota represents contents of GETQUOTA response.
-    # This object can also be a response to GETQUOTAROOT.  In the syntax
-    # specification below, the delimiter used with the "#" construct is a
-    # single space (SPACE).
+    # MailboxQuota represents the data of an untagged +QUOTA+ response.
     #
-    # Net:IMAP#getquota returns an array of MailboxQuota objects.
+    # IMAP#getquota returns an array of MailboxQuota objects.
     #
     # Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
     # and MailboxQuota objects.
     #
+    # == Required capability
+    # Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
+    # capability.
     class MailboxQuota < Struct.new(:mailbox, :usage, :quota)
       ##
       # method: mailbox
@@ -441,12 +454,14 @@ module Net
       #
     end
 
-    # Net::IMAP::MailboxQuotaRoot represents part of the GETQUOTAROOT
-    # response. (GETQUOTAROOT can also return Net::IMAP::MailboxQuota.)
+    # MailboxQuotaRoot represents the data of an untagged +QUOTAROOT+ response.
     #
-    # Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
-    # and MailboxQuota objects.
+    # IMAP#getquotaroot returns an array containing both MailboxQuotaRoot and
+    # MailboxQuota objects.
     #
+    # == Required capability
+    # Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
+    # capability.
     class MailboxQuotaRoot < Struct.new(:mailbox, :quotaroots)
       ##
       # method: mailbox
@@ -461,12 +476,13 @@ module Net
       # Zero or more quotaroots that affect the quota on the specified mailbox.
     end
 
-    # Net::IMAP::MailboxACLItem represents the response from GETACL.
+    # MailboxACLItem represents the data of an untagged +ACL+ response.
     #
-    # Net::IMAP#getacl returns an array of MailboxACLItem objects.
+    # IMAP#getacl returns an array of MailboxACLItem objects.
     #
-    # ==== Required capability
-    # +ACL+ - described in [ACL[https://tools.ietf.org/html/rfc4314]]
+    # == Required capability
+    # Requires +ACL+ [RFC4314[https://www.rfc-editor.org/rfc/rfc4314]]
+    # capability.
     class MailboxACLItem < Struct.new(:user, :rights, :mailbox)
       ##
       # method: mailbox
@@ -488,11 +504,12 @@ module Net
       # The access rights the indicated #user has to the #mailbox.
     end
 
-    # Net::IMAP::Namespace represents a single namespace contained inside a
-    # NAMESPACE response.
-    #
-    # Returned by Net::IMAP#namespace, contained inside a Namespaces object.
+    # Namespace represents a _single_ namespace, contained inside a Namespaces
+    # object.
     #
+    # == Required capability
+    # Requires either +NAMESPACE+ [RFC2342[https://www.rfc-editor.org/rfc/rfc2342]]
+    # or +IMAP4rev2+ capability.
     class Namespace < Struct.new(:prefix, :delim, :extensions)
       ##
       # method: prefix
@@ -514,11 +531,14 @@ module Net
       # Extension parameter semantics would be defined by the extension.
     end
 
-    # Net::IMAP::Namespaces represents a +NAMESPACE+ server response, which
-    # contains lists of #personal, #shared, and #other namespaces.
+    # Namespaces represents the data of an untagged +NAMESPACE+ response,
+    # returned by IMAP#namespace.
     #
-    # Net::IMAP#namespace returns a Namespaces object.
+    # Contains lists of #personal, #shared, and #other namespaces.
     #
+    # == Required capability
+    # Requires either +NAMESPACE+ [RFC2342[https://www.rfc-editor.org/rfc/rfc2342]]
+    # or +IMAP4rev2+ capability.
     class Namespaces < Struct.new(:personal, :other, :shared)
       ##
       # method: personal
@@ -539,9 +559,9 @@ module Net
       # Returns an array of Shared Namespace objects.
     end
 
-    # Net::IMAP::StatusData represents the contents of the STATUS response.
+    # StatusData represents the contents of an untagged +STATUS+ response.
     #
-    # Net::IMAP#status returns the contents of #attr.
+    # IMAP#status returns the contents of #attr.
     class StatusData < Struct.new(:mailbox, :attr)
       ##
       # method: mailbox
@@ -562,11 +582,11 @@ module Net
     # [Note]
     #   When the #sender and #reply_to fields are absent or empty, they will
     #   return the same value as #from.  Also, fields may return values that are
-    #   invalid for well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+    #   invalid for well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
     #   messages when the message is malformed or a draft message.
     #
-    # See [{IMAP4rev1 §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]]
-    # and [{IMAP4rev2 §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2]]
+    # See [{IMAP4rev1 §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]]
+    # and [{IMAP4rev2 §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2]]
     # for full description of the envelope fields, and
     # Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
     #
@@ -580,7 +600,7 @@ module Net
       # Returns a string that represents the +Date+ header.
       #
       # [Note]
-      #   For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+      #   For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
       #   message, the #date field must not be +nil+.  However it can be +nil+
       #   for a malformed or draft message.
 
@@ -606,7 +626,7 @@ module Net
       # returns +nil+ for this envelope field.
       #
       # [Note]
-      #   For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+      #   For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
       #   message, the #from field must not be +nil+.  However it can be +nil+
       #   for a malformed or draft message.
 
@@ -619,7 +639,7 @@ module Net
       # [Note]
       #   If the <tt>Sender</tt> header is absent, or is present but empty, the
       #   server sets this field to be the same value as #from.  Therefore, in a
-      #   well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]] message,
+      #   well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] message,
       #   the #sender envelope field must not be +nil+.  However it can be
       #   +nil+ for a malformed or draft message.
 
@@ -633,7 +653,7 @@ module Net
       # [Note]
       #   If the <tt>Reply-To</tt> header is absent, or is present but empty,
       #   the server sets this field to be the same value as #from.  Therefore,
-      #   in a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+      #   in a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
       #   message, the #reply_to envelope field must not be +nil+.  However it
       #   can be +nil+ for a malformed or draft message.
 
@@ -662,7 +682,7 @@ module Net
       # Returns a string that represents the <tt>In-Reply-To</tt> header.
       #
       # [Note]
-      #   For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+      #   For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
       #   message, the #in_reply_to field, if present, must not be empty.  But
       #   it can still return an empty string for malformed messages.
       #
@@ -678,7 +698,7 @@ module Net
       # Returns a string that represents the <tt>Message-ID</tt>.
       #
       # [Note]
-      #   For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
+      #   For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
       #   message, the #message_id field, if present, must not be empty.  But it
       #   can still return an empty string for malformed messages.
       #
@@ -692,10 +712,10 @@ module Net
     # parsed into its component parts by the server.  Address objects are
     # returned within Envelope fields.
     #
-    # === Group syntax
+    # == Group syntax
     #
     # When the #host field is +nil+, this is a special form of address structure
-    # that indicates the [RFC5322[https://tools.ietf.org/html/rfc5322]] group
+    # that indicates the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group
     # syntax.  If the #mailbox name field is also +nil+, this is an end-of-group
     # marker (semicolon in RFC-822 syntax).  If the #mailbox name field is
     # non-+NIL+, this is the start of a group marker, and the mailbox #name
@@ -705,7 +725,7 @@ module Net
       # method: name
       # :call-seq: name -> string or nil
       #
-      # Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] address
+      # Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] address
       # +display-name+ (or the mailbox +phrase+ in the RFC-822 grammar).
 
       ##
@@ -715,28 +735,28 @@ module Net
       # Returns the route from RFC-822 route-addr.
       #
       # Note:: Generating this obsolete route addressing syntax is not allowed
-      #        by [RFC5322[https://tools.ietf.org/html/rfc5322]].  However,
+      #        by [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]].  However,
       #        addresses with this syntax must still be accepted and parsed.
 
       ##
       # method: mailbox
       # :call-seq: mailbox -> string or nil
       #
-      # Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] address
+      # Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] address
       # +local-part+, if #host is not +nil+.
       #
       # When #host is +nil+, this returns
-      # an [RFC5322[https://tools.ietf.org/html/rfc5322]] group name and a +nil+
+      # an [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group name and a +nil+
       # mailbox indicates the end of a group.
 
       ##
       # method: host
       # :call-seq: host -> string or nil
       #
-      # Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] addr-spec
+      # Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] addr-spec
       # +domain+ name.
       #
-      # +nil+ indicates [RFC5322[https://tools.ietf.org/html/rfc5322]] group
+      # +nil+ indicates [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group
       # syntax.
     end
 
@@ -748,14 +768,14 @@ module Net
       # :call-seq: dsp_type -> string
       #
       # Returns the content disposition type, as defined by
-      # [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
+      # [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
 
       ##
       # method: param
       # :call-seq: param -> hash
       #
       # Returns a hash representing parameters of the Content-Disposition
-      # field, as defined by [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
+      # field, as defined by [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
     end
 
     # Net::IMAP::ThreadMember represents a thread-node returned
@@ -794,12 +814,12 @@ module Net
     # FetchData#attr value.  Although these classes don't share a base class,
     # this module can be used to pattern match all of them.
     #
-    # See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]
-    # and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2-4.9]
+    # See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]
+    # and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2-4.9]
     # for full description of all +BODYSTRUCTURE+ fields, and also
     # Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
     #
-    # === Classes that include BodyStructure
+    # == Classes that include BodyStructure
     # BodyTypeBasic:: Represents any message parts that are not handled by
     #                 BodyTypeText, BodyTypeMessage, or BodyTypeMultipart.
     # BodyTypeText:: Used by <tt>text/*</tt> parts.  Contains all of the
@@ -817,8 +837,8 @@ module Net
     # message parts, unless they have a <tt>Content-Type</tt> that is handled by
     # BodyTypeText, BodyTypeMessage, or BodyTypeMultipart.
     #
-    # See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]
-    # and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2-4.9]
+    # See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]
+    # and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2-4.9]
     # for full description of all +BODYSTRUCTURE+ fields, and also
     # Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
     #
@@ -835,45 +855,45 @@ module Net
       # :call-seq: media_type -> string
       #
       # The top-level media type as defined in
-      # [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
+      # [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
 
       ##
       # method: subtype
       # :call-seq: subtype -> string
       #
       # The media subtype name as defined in
-      # [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
+      # [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
 
       ##
       # method: param
       # :call-seq: param -> string
       #
       # Returns a hash that represents parameters as defined in
-      # [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
+      # [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
 
       ##
       # method: content_id
       # :call-seq: content_id -> string
       #
       # Returns a string giving the content id as defined
-      # in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
-      # {§7}[https://tools.ietf.org/html/rfc2045#section-7].
+      # in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
+      # {§7}[https://www.rfc-editor.org/rfc/rfc2045#section-7].
 
       ##
       # method: description
       # :call-seq: description -> string
       #
       # Returns a string giving the content description as defined
-      # in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
-      # {§8}[https://tools.ietf.org/html/rfc2045#section-8].
+      # in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
+      # {§8}[https://www.rfc-editor.org/rfc/rfc2045#section-8].
 
       ##
       # method: encoding
       # :call-seq: encoding -> string
       #
       # Returns a string giving the content transfer encoding as defined
-      # in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
-      # {§6}[https://tools.ietf.org/html/rfc2045#section-6].
+      # in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
+      # {§6}[https://www.rfc-editor.org/rfc/rfc2045#section-6].
 
       ##
       # method: size
@@ -886,7 +906,7 @@ module Net
       # :call-seq: md5 -> string
       #
       # Returns a string giving the body MD5 value as defined in
-      # [MD5[https://tools.ietf.org/html/rfc1864]].
+      # [MD5[https://www.rfc-editor.org/rfc/rfc1864]].
 
       ##
       # method: disposition
@@ -894,7 +914,7 @@ module Net
       #
       # Returns a ContentDisposition object giving the content
       # disposition, as defined by
-      # [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
+      # [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
 
       ##
       # method: language
@@ -939,7 +959,8 @@ module Net
       # for something else?
       #++
       def media_subtype
-        warn("media_subtype is obsolete, use subtype instead.\n", uplevel: 1)
+        warn("media_subtype is obsolete, use subtype instead.\n",
+             uplevel: 1, category: :deprecated)
         return subtype
       end
     end
@@ -984,7 +1005,8 @@ module Net
       # generate a warning message to +stderr+, then return
       # the value of +subtype+.
       def media_subtype
-        warn("media_subtype is obsolete, use subtype instead.\n", uplevel: 1)
+        warn("media_subtype is obsolete, use subtype instead.\n",
+             uplevel: 1, category: :deprecated)
         return subtype
       end
     end
@@ -1040,77 +1062,6 @@ module Net
       end
     end
 
-    # BodyTypeAttachment is not used and will be removed in an upcoming release.
-    #
-    # === Bug Analysis
-    #
-    # \IMAP body structures are parenthesized lists and assign their fields
-    # positionally, so missing fields change the interpretation of all
-    # following fields.  Additionally, different body types have a different
-    # number of required fields, followed by optional "extension" fields.
-    #
-    # BodyTypeAttachment was previously returned when a "message/rfc822" part,
-    # which should be sent as <tt>body-type-msg</tt> with ten required fields,
-    # was actually sent as a <tt>body-type-basic</tt> with _seven_ required
-    # fields.
-    #
-    #   basic => type, subtype, param, id, desc, enc, octets, md5=nil,  dsp=nil, lang=nil, loc=nil, *ext
-    #   msg   => type, subtype, param, id, desc, enc, octets, envelope, body,    lines,    md5=nil, ...
-    #
-    # Normally, +envelope+ and +md5+ are incompatible, but Net::IMAP leniently
-    # allowed buggy servers to send +NIL+ for +envelope+.  As a result, when a
-    # server sent a <tt>message/rfc822</tt> part with +NIL+ for +md5+ and a
-    # non-<tt>NIL</tt> +dsp+, Net::IMAP misinterpreted the
-    # <tt>Content-Disposition</tt> as if it were a strange body type.  In all
-    # reported cases, the <tt>Content-Disposition</tt> was "attachment", so
-    # BodyTypeAttachment was created as the workaround.
-    #
-    # === Current behavior
-    #
-    # When interpreted strictly, +envelope+ and +md5+ are incompatible.  So the
-    # current parsing algorithm peeks ahead after it has received the seventh
-    # body field.  If the next token is not the start of an +envelope+, we assume
-    # the server has incorrectly sent us a <tt>body-type-basic</tt> and return
-    # BodyTypeBasic.  As a result, what was previously BodyTypeMessage#body =>
-    # BodyTypeAttachment is now BodyTypeBasic#disposition => ContentDisposition.
-    #
-    class BodyTypeAttachment < Struct.new(:dsp_type, :_unused_, :param)
-      # *invalid for BodyTypeAttachment*
-      def media_type
-        warn(<<~WARN, uplevel: 1)
-          BodyTypeAttachment#media_type is obsolete.  Use dsp_type instead.
-        WARN
-        dsp_type
-      end
-
-      # *invalid for BodyTypeAttachment*
-      def subtype
-        warn("BodyTypeAttachment#subtype is obsolete.\n", uplevel: 1)
-        nil
-      end
-
-      ##
-      # method: dsp_type
-      # :call-seq: dsp_type -> string
-      #
-      # Returns the content disposition type, as defined by
-      # [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
-
-      ##
-      # method: param
-      # :call-seq: param -> hash
-      #
-      # Returns a hash representing parameters of the Content-Disposition
-      # field, as defined by [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
-
-      ##
-      def multipart?
-        return false
-      end
-    end
-
-    deprecate_constant :BodyTypeAttachment
-
     # Net::IMAP::BodyTypeMultipart represents body structures of messages and
     # message parts, when <tt>Content-Type</tt> is <tt>multipart/*</tt>.
     class BodyTypeMultipart < Struct.new(:media_type, :subtype,
@@ -1131,7 +1082,7 @@ module Net
       # call-seq: subtype -> string
       #
       # Returns the content subtype name
-      # as defined in [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
+      # as defined in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
 
       ##
       # method: parts
@@ -1145,7 +1096,7 @@ module Net
       # call-seq: param -> hash
       #
       # Returns a hash that represents parameters
-      # as defined in [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
+      # as defined in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
 
       ##
       # method: disposition
@@ -1182,29 +1133,11 @@ module Net
       # generate a warning message to +stderr+, then return
       # the value of +subtype+.
       def media_subtype
-        warn("media_subtype is obsolete, use subtype instead.\n", uplevel: 1)
+        warn("media_subtype is obsolete, use subtype instead.\n",
+             uplevel: 1, category: :deprecated)
         return subtype
       end
     end
 
-    # === Obsolete
-    # BodyTypeExtension is not used and will be removed in an upcoming release.
-    #
-    # >>>
-    #   BodyTypeExtension was (incorrectly) used for <tt>message/*</tt> parts
-    #   (besides <tt>message/rfc822</tt>, which correctly uses BodyTypeMessage).
-    #
-    #   Net::IMAP now (correctly) parses all message types (other than
-    #   <tt>message/rfc822</tt> or <tt>message/global</tt>) as BodyTypeBasic.
-    class BodyTypeExtension < Struct.new(:media_type, :subtype,
-                                         :params, :content_id,
-                                         :description, :encoding, :size)
-      def multipart?
-        return false
-      end
-    end
-
-    deprecate_constant :BodyTypeExtension
-
   end
 end