net-imap 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce3f04b1c49832a6e2b36c2b9b9a7a79223c297896aa7daeb7bf7fd0b54a7f6
-  data.tar.gz: 2ce12d9e40a529f638a4314f6c61ebf343a5341225fa4c2442800be339a32dea
+  metadata.gz: a91d908ae16db12c507a6cf5c0e5eef57e18c97473b2a13a0ab14cf655e9bcb7
+  data.tar.gz: 1bdab36cf0779d14e2f414e00aee90d95d2584bfc8d591c11d5104b4071bebb8
 SHA512:
-  metadata.gz: 8933d844581528c0b969e4e5256821a41cf7838f1fed493205c2447e3fd5578df6f9f1eb75f24cb14c8a227b3908218224c161da3a61a26dab2b66d819738d03
-  data.tar.gz: 9b37cf6d107aa5e4a5bd650faac5f4fb4f2a4d2283068bd1b39793db2a5a3b1e6dcc86e5b850efc4e008ddbe0a0632d367ad0fb473e1e7158633c09726dc7f25
+  metadata.gz: 65133026b0746efbdc55a64bd1091da0524e5b922672767f334cec1d0357b31b973380bc8e787ff2430b831375f52050004d718b6308fa9203c9f6710ac2444b
+  data.tar.gz: 7e5e9fcac352549585e38b5a86b0198cc1c5996ad129cf9e53ca92f2ef63ea4b37d26ab8c5efd641b19711b2ea04e42622ead203c3afcaa8d420ceaaaa9893c8

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby: [ '3.0', 2.7, 2.5, head ]
+        ruby: [ head, '3.1', '3.0', '2.7' ]
         os: [ ubuntu-latest, macos-latest ]
         experimental: [false]
         include:
@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/LICENSE.txt

@@ -20,3 +20,65 @@ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
+
+-------------------------------------------------------------------------
+
+This software includes documentation which has been copied from the relevant
+RFCs.  The copied documentation is covered by the following licenses:
+
+RFC 3501 (Editor: M. Crispin)
+Full Copyright Statement
+
+   Copyright (C) The Internet Society (2003).  All Rights Reserved.
+
+   This document and translations of it may be copied and furnished to
+   others, and derivative works that comment on or otherwise explain it
+   or assist in its implementation may be prepared, copied, published
+   and distributed, in whole or in part, without restriction of any
+   kind, provided that the above copyright notice and this paragraph are
+   included on all such copies and derivative works.  However, this
+   document itself may not be modified in any way, such as by removing
+   the copyright notice or references to the Internet Society or other
+   Internet organizations, except as needed for the purpose of
+   developing Internet standards in which case the procedures for
+   copyrights defined in the Internet Standards process must be
+   followed, or as required to translate it into languages other than
+   English.
+
+   The limited permissions granted above are perpetual and will not be
+   revoked by the Internet Society or its successors or assigns.  v This
+   document and the information contained herein is provided on an "AS
+   IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
+   FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+   LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL
+   NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY
+   OR FITNESS FOR A PARTICULAR PURPOSE.
+
+
+RFC9051 (Editors: A. Melnikov, B. Leiba)
+Copyright Notice
+
+   Copyright (c) 2021 IETF Trust and the persons identified as the
+   document authors.  All rights reserved.
+
+   This document is subject to BCP 78 and the IETF Trust's Legal
+   Provisions Relating to IETF Documents
+   (https://trustee.ietf.org/license-info) in effect on the date of
+   publication of this document.  Please review these documents
+   carefully, as they describe your rights and restrictions with respect
+   to this document.  Code Components extracted from this document must
+   include Simplified BSD License text as described in Section 4.e of
+   the Trust Legal Provisions and are provided without warranty as
+   described in the Simplified BSD License.
+
+   This document may contain material from IETF Documents or IETF
+   Contributions published or made publicly available before November
+   10, 2008.  The person(s) controlling the copyright in some of this
+   material may not have granted the IETF Trust the right to allow
+   modifications of such material outside the IETF Standards Process.
+   Without obtaining an adequate license from the person(s) controlling
+   the copyright in such materials, this document may not be modified
+   outside the IETF Standards Process, and derivative works of it may
+   not be created outside the IETF Standards Process, except to format
+   it for publication as an RFC or to translate it into languages other
+   than English.

data/Rakefile

@@ -7,4 +7,11 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+task :sync_tool do
+  require 'fileutils'
+  FileUtils.cp "../ruby/tool/lib/core_assertions.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/envutil.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/find_executable.rb", "./test/lib"
+end
+
 task :default => :test

data/lib/net/imap/authenticators/cram_md5.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "digest/md5"
-
 # Authenticator for the "+CRAM-MD5+" SASL mechanism, specified in
 # RFC2195[https://tools.ietf.org/html/rfc2195].  See Net::IMAP#authenticate.
 #
@@ -23,7 +21,11 @@ class Net::IMAP::CramMD5Authenticator
 
   private
 
-  def initialize(user, password)
+  def initialize(user, password, warn_deprecation: true, **_ignored)
+    if warn_deprecation
+      warn "WARNING: CRAM-MD5 mechanism is deprecated." # TODO: recommend SCRAM
+    end
+    require "digest/md5"
     @user = user
     @password = password
   end
@@ -45,5 +47,5 @@ class Net::IMAP::CramMD5Authenticator
     return Digest::MD5.hexdigest(k_opad + digest)
   end
 
-  Net::IMAP.add_authenticator "PLAIN", self
+  Net::IMAP.add_authenticator "CRAM-MD5", self
 end

data/lib/net/imap/authenticators/digest_md5.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "digest/md5"
-require "strscan"
-
 # Net::IMAP authenticator for the "`DIGEST-MD5`" SASL mechanism type, specified
 # in RFC2831(https://tools.ietf.org/html/rfc2831).  See Net::IMAP#authenticate.
 #
@@ -29,8 +26,8 @@ class Net::IMAP::DigestMD5Authenticator
         sparams[k] = v
       end
 
-      raise DataFormatError, "Bad Challenge: '#{challenge}'" unless c.rest.size == 0
-      raise Error, "Server does not support auth (qop = #{sparams['qop'].join(',')})" unless sparams['qop'].include?("auth")
+      raise Net::IMAP::DataFormatError, "Bad Challenge: '#{challenge}'" unless c.eos?
+      raise Net::IMAP::Error, "Server does not support auth (qop = #{sparams['qop'].join(',')})" unless sparams['qop'].include?("auth")
 
       response = {
         :nonce => sparams['nonce'],
@@ -77,11 +74,18 @@ class Net::IMAP::DigestMD5Authenticator
     end
   end
 
-  def initialize(user, password, authname = nil)
+  def initialize(user, password, authname = nil, warn_deprecation: true)
+    if warn_deprecation
+      warn "WARNING: DIGEST-MD5 SASL mechanism was deprecated by RFC6331."
+      # TODO: recommend SCRAM instead.
+    end
+    require "digest/md5"
+    require "strscan"
     @user, @password, @authname = user, password, authname
     @nc, @stage = {}, STAGE_ONE
   end
 
+
   private
 
   STAGE_ONE = :stage_one
@@ -100,7 +104,7 @@ class Net::IMAP::DigestMD5Authenticator
   def qdval(k, v)
     return if k.nil? or v.nil?
     if %w"username authzid realm nonce cnonce digest-uri qop".include? k
-      v.gsub!(/([\\"])/, "\\\1")
+      v = v.gsub(/([\\"])/, "\\\1")
       return '%s="%s"' % [k, v]
     else
       return '%s=%s' % [k, v]

data/lib/net/imap/authenticators/login.rb

@@ -33,7 +33,10 @@ class Net::IMAP::LoginAuthenticator
   STATE_USER = :USER
   STATE_PASSWORD = :PASSWORD
 
-  def initialize(user, password)
+  def initialize(user, password, warn_deprecation: true, **_ignored)
+    if warn_deprecation
+      warn "WARNING: LOGIN SASL mechanism is deprecated. Use PLAIN instead."
+    end
     @user = user
     @password = password
     @state = STATE_USER

data/lib/net/imap/authenticators.rb

@@ -19,13 +19,15 @@ module Net::IMAP::Authenticators
 
   # Builds an authenticator for Net::IMAP#authenticate.  +args+ will be passed
   # directly to the chosen authenticator's +#initialize+.
-  def authenticator(auth_type, *args)
-    auth_type = auth_type.upcase
-    unless authenticators.has_key?(auth_type)
-      raise ArgumentError,
-        format('unknown auth type - "%s"', auth_type)
+  def authenticator(mechanism, *authargs, **properties, &callback)
+    authenticator = authenticators.fetch(mechanism.upcase) do
+      raise ArgumentError, 'unknown auth type - "%s"' % mechanism
+    end
+    if authenticator.respond_to?(:new)
+      authenticator.new(*authargs, **properties, &callback)
+    else
+      authenticator.call(*authargs, **properties, &callback)
     end
-    authenticators[auth_type].new(*args)
   end
 
   private
@@ -38,7 +40,8 @@ end
 
 Net::IMAP.extend Net::IMAP::Authenticators
 
-require_relative "authenticators/login"
 require_relative "authenticators/plain"
+
+require_relative "authenticators/login"
 require_relative "authenticators/cram_md5"
 require_relative "authenticators/digest_md5"

data/lib/net/imap/command_data.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "errors"
+
 module Net
   class IMAP < Protocol
 

data/lib/net/imap/data_encoding.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "errors"
+
 module Net
   class IMAP < Protocol
 
@@ -43,5 +45,62 @@ module Net
       return time.strftime('%d-%b-%Y %H:%M %z')
     end
 
+    # Common validators of number and nz_number types
+    module NumValidator # :nodoc
+      module_function
+
+      # Check is passed argument valid 'number' in RFC 3501 terminology
+      def valid_number?(num)
+        # [RFC 3501]
+        # number          = 1*DIGIT
+        #                    ; Unsigned 32-bit integer
+        #                    ; (0 <= n < 4,294,967,296)
+        num >= 0 && num < 4294967296
+      end
+
+      # Check is passed argument valid 'nz_number' in RFC 3501 terminology
+      def valid_nz_number?(num)
+        # [RFC 3501]
+        # nz-number       = digit-nz *DIGIT
+        #                    ; Non-zero unsigned 32-bit integer
+        #                    ; (0 < n < 4,294,967,296)
+        num != 0 && valid_number?(num)
+      end
+
+      # Check is passed argument valid 'mod_sequence_value' in RFC 4551 terminology
+      def valid_mod_sequence_value?(num)
+        # mod-sequence-value  = 1*DIGIT
+        #                        ; Positive unsigned 64-bit integer
+        #                        ; (mod-sequence)
+        #                        ; (1 <= n < 18,446,744,073,709,551,615)
+        num >= 1 && num < 18446744073709551615
+      end
+
+      # Ensure argument is 'number' or raise DataFormatError
+      def ensure_number(num)
+        return if valid_number?(num)
+
+        msg = "number must be unsigned 32-bit integer: #{num}"
+        raise DataFormatError, msg
+      end
+
+      # Ensure argument is 'nz_number' or raise DataFormatError
+      def ensure_nz_number(num)
+        return if valid_nz_number?(num)
+
+        msg = "nz_number must be non-zero unsigned 32-bit integer: #{num}"
+        raise DataFormatError, msg
+      end
+
+      # Ensure argument is 'mod_sequence_value' or raise DataFormatError
+      def ensure_mod_sequence_value(num)
+        return if valid_mod_sequence_value?(num)
+
+        msg = "mod_sequence_value must be unsigned 64-bit integer: #{num}"
+        raise DataFormatError, msg
+      end
+
+    end
+
   end
 end

data/lib/net/imap/errors.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Net
+  class IMAP < Protocol
+
+    # Superclass of IMAP errors.
+    class Error < StandardError
+    end
+
+    # Error raised when data is in the incorrect format.
+    class DataFormatError < Error
+    end
+
+    # Error raised when a response from the server is non-parseable.
+    class ResponseParseError < Error
+    end
+
+    # Superclass of all errors used to encapsulate "fail" responses
+    # from the server.
+    class ResponseError < Error
+
+      # The response that caused this error
+      attr_accessor :response
+
+      def initialize(response)
+        @response = response
+
+        super @response.data.text
+      end
+
+    end
+
+    # Error raised upon a "NO" response from the server, indicating
+    # that the client command could not be completed successfully.
+    class NoResponseError < ResponseError
+    end
+
+    # Error raised upon a "BAD" response from the server, indicating
+    # that the client command violated the IMAP protocol, or an internal
+    # server failure has occurred.
+    class BadResponseError < ResponseError
+    end
+
+    # Error raised upon a "BYE" response from the server, indicating
+    # that the client is not being allowed to login, or has been timed
+    # out due to inactivity.
+    class ByeResponseError < ResponseError
+    end
+
+    # Error raised upon an unknown response from the server.
+    class UnknownResponseError < ResponseError
+    end
+
+    RESPONSE_ERRORS = Hash.new(ResponseError)
+    RESPONSE_ERRORS["NO"] = NoResponseError
+    RESPONSE_ERRORS["BAD"] = BadResponseError
+
+  end
+end

data/lib/net/imap/flags.rb

@@ -3,74 +3,232 @@
 module Net
   class IMAP < Protocol
 
-    # :category: Message Flags
+    # -------------------------------------------------------------------------
+    # :section: Message Flags: system flags
     #
-    # Flag indicating a message has been seen.
+    # A message has a list of zero or more named tokens, known as "flags",
+    # associated with it. A flag is set by its addition to this list and is
+    # cleared by its removal. There are two types of flags in IMAP4rev2: system
+    # flags and keywords. A flag of either type can be permanent or
+    # session-only.
+    #
+    # A "system flag" is a message flag name that is predefined in the IMAP
+    # specification and begins with "\".  +Net::IMAP+ returns all system flags
+    # as symbols, without the "\" prefix.
+    #
+    # The descriptions here were copied from the IMAP4rev2 specification:
+    # [RFC-9051 § 2.3.2](https://www.rfc-editor.org/rfc/rfc9051.html#section-2.3.2)
+    #
+    # See [RFC-3501 § 2.3.2](https://www.rfc-editor.org/rfc/rfc3501.html#section-2.3.2)
+    # for a description of the flags message attribute and system flag semantics
+    # in IMAP4rev1.
+    # -------------------------------------------------------------------------
+
+    # Flag indicating a message has been read.
     SEEN = :Seen
 
-    # :category: Message Flags
-    #
     # Flag indicating a message has been answered.
     ANSWERED = :Answered
 
-    # :category: Message Flags
-    #
-    # Flag indicating a message has been flagged for special or urgent
+    # A message flag indicating a message has been flagged for special or urgent
     # attention.
+    #
+    # Also a mailbox special use attribute, which indicates that this mailbox
+    # presents all messages marked in some way as "important".  When this
+    # special use is supported, it is likely to represent a virtual mailbox
+    # collecting messages (from other mailboxes) that are marked with the
+    # "\Flagged" message flag.
     FLAGGED = :Flagged
 
-    # :category: Message Flags
-    #
     # Flag indicating a message has been marked for deletion.  This
     # will occur when the mailbox is closed or expunged.
     DELETED = :Deleted
 
-    # :category: Message Flags
-    #
     # Flag indicating a message is only a draft or work-in-progress version.
     DRAFT = :Draft
 
-    # :category: Message Flags
-    #
     # Flag indicating that the message is "recent," meaning that this
     # session is the first session in which the client has been notified
     # of this message.
+    #
+    # This flag was defined by
+    # IMAP4rev1 [RFC-3501](https://www.rfc-editor.org/rfc/rfc3501.html),
+    # and has been deprecated by
+    # IMAP4rev2 [RFC-9051](https://www.rfc-editor.org/rfc/rfc9051.html).
     RECENT = :Recent
 
-    # :category: Mailbox Flags
+    # -------------------------------------------------------------------------
+    # :section: Mailbox Name Attributes, Base attributes
+    # Mailbox name attributes will be returned in LIST responses.  Base
+    # attributes must be returned according to the server's capabilities.
     #
-    # Flag indicating that a mailbox context name cannot contain
-    # children.
-    NOINFERIORS = :Noinferiors
+    # IMAP4 specifies that all mailbox name attributes, including future
+    # extensions, begin with "\".  +Net::IMAP+ returns all mailbox attributes as
+    # symbols, without the "\" prefix.
+    #
+    # The descriptions here were copied from the IMAP4rev2 specification:
+    # [RFC9051 § 7.3.1](https://www.rfc-editor.org/rfc/rfc9051.html#section-7.3.1).
+    #
+    # Other mailbox name attributes can be found in the [IANA IMAP Mailbox Name
+    # Attributes registry](https://www.iana.org/assignments/imap-mailbox-name-attributes/imap-mailbox-name-attributes.xhtml)].
+    # -------------------------------------------------------------------------
+
+    # The "\NonExistent" attribute indicates that a mailbox name does not refer
+    # to an existing mailbox. Note that this attribute is not meaningful by
+    # itself, as mailbox names that match the canonical LIST pattern but don't
+    # exist must not be returned unless one of the two conditions listed below
+    # is also satisfied:
+    #
+    # 1. The mailbox name also satisfies the selection criteria (for example,
+    #    it is subscribed and the "SUBSCRIBED" selection option has been
+    #    specified).
+    #
+    # 2. "RECURSIVEMATCH" has been specified, and the mailbox name has at least
+    #    one descendant mailbox name that does not match the LIST pattern and
+    #    does match the selection criteria.
+    #
+    # In practice, this means that the "\NonExistent" attribute is usually
+    # returned with one or more of "\Subscribed", "\Remote", "\HasChildren", or
+    # the CHILDINFO extended data item.
+    #
+    # The client must treat the presence of the \NonExistent attribute as if the
+    # \NoSelect attribute was also sent by the server
+    NONEXISTENT = :NonExistent
 
-    # :category: Mailbox Flags
+    # Mailbox attribute indicating it is not possible for any child levels of
+    # hierarchy to exist under this name; no child levels exist now and none can
+    # be created in the future children.
     #
-    # Flag indicating that a mailbox is not selected.
+    # The client must treat the presence of the \NoInferiors attribute as if the
+    # \HasNoChildren attribute was also sent by the server
+    NOINFERIORS = :Noinferiors
+
+    # Mailbox attribute indicating it is not possible to use this name as a
+    # selectable mailbox.
     NOSELECT = :Noselect
 
-    # :category: Mailbox Flags
+    # The presence of this attribute indicates that the mailbox has child
+    # mailboxes. A server SHOULD NOT set this attribute if there are child
+    # mailboxes and the user does not have permission to access any of them.  In
+    # this case, \HasNoChildren SHOULD be used. In many cases, however, a server
+    # may not be able to efficiently compute whether a user has access to any
+    # child mailboxes. Note that even though the \HasChildren attribute for a
+    # mailbox must be correct at the time of processing the mailbox, a client
+    # must be prepared to deal with a situation when a mailbox is marked with
+    # the \HasChildren attribute, but no child mailbox appears in the response
+    # to the LIST command. This might happen, for example, due to child
+    # mailboxes being deleted or made inaccessible to the user (using access
+    # control) by another client before the server is able to list them.
+    #
+    # It is an error for the server to return both a \HasChildren and a
+    # \HasNoChildren attribute in the same LIST response. A client that
+    # encounters a LIST response with both \HasChildren and \HasNoChildren
+    # attributes present should act as if both are absent in the LIST response.
+    HAS_CHILDREN = :HasChildren
+
+    # The presence of this attribute indicates that the mailbox has NO child
+    # mailboxes that are accessible to the currently authenticated user.
     #
-    # Flag indicating that a mailbox has been marked "interesting" by
-    # the server; this commonly indicates that the mailbox contains
-    # new messages.
+    # It is an error for the server to return both a \HasChildren and a
+    # \HasNoChildren attribute in the same LIST response. A client that
+    # encounters a LIST response with both \HasChildren and \HasNoChildren
+    # attributes present should act as if both are absent in the LIST response.
+    #
+    # Note: the \HasNoChildren attribute should not be confused with the
+    # \NoInferiors attribute, which indicates that no child mailboxes exist now
+    # and none can be created in the future.
+    HAS_NO_CHILDREN = :HasNoChildren
+
+    # The mailbox has been marked "interesting" by the server; the mailbox
+    # probably contains messages that have been added since the last time the
+    # mailbox was selected.
+    #
+    # If it is not feasible for the server to determine whether or not the
+    # mailbox is "interesting", the server SHOULD NOT send either \Marked or
+    # \Unmarked. The server MUST NOT send more than one of \Marked, \Unmarked,
+    # and \Noselect for a single mailbox, and it MAY send none of these.
     MARKED = :Marked
 
-    # :category: Mailbox Flags
+    # The mailbox does not contain any additional messages since the last time
+    # the mailbox was selected.
     #
-    # Flag indicating that the mailbox does not contains new messages.
+    # If it is not feasible for the server to determine whether or not the
+    # mailbox is "interesting", the server SHOULD NOT send either \Marked or
+    # \Unmarked. The server MUST NOT send more than one of \Marked, \Unmarked,
+    # and \Noselect for a single mailbox, and it MAY send none of these.
     UNMARKED = :Unmarked
 
-    @@max_flag_count = 10000
+    # The mailbox name was subscribed to using the SUBSCRIBE command.
+    SUBSCRIBED = :Subscribed
+
+    # The mailbox is a remote mailbox.
+    REMOTE = :Remove
+
+    # -------------------------------------------------------------------------
+    # :section: Mailbox Name Attributes, Special Use
+    # Mailbox name attributes will be returned in LIST responses.  In addition
+    # to the base mailbox name attributes defined above, an IMAP server MAY also
+    # include any or all of the following attributes that denote "role" (or
+    # "special-use") of a mailbox. These attributes are included along with base
+    # attributes defined above. A given mailbox may have none, one, or more than
+    # one of these attributes. In some cases, a special use is advice to a
+    # client about what to put in that mailbox. In other cases, it's advice to a
+    # client about what to expect to find there.
+    #
+    # IMAP4 specifies that all mailbox name attributes, including future
+    # extensions, begin with "\".  +Net::IMAP+ returns all mailbox attributes as
+    # symbols, without the "\" prefix.
+    #
+    # The descriptions here were copied from the IMAP4rev2 specification:
+    # [RFC-9051 § 7.3.1](https://www.rfc-editor.org/rfc/rfc9051.html#section-7.3.1).
+    #
+    # Other mailbox name attributes can be found in the [IANA IMAP Mailbox Name
+    # Attributes registry](https://www.iana.org/assignments/imap-mailbox-name-attributes/imap-mailbox-name-attributes.xhtml)].
+    # -------------------------------------------------------------------------
+
+    # Mailbox attribute indicating that this mailbox presents all messages in
+    # the user's message store. Implementations MAY omit some messages, such as,
+    # perhaps, those in \Trash and \Junk. When this special use is supported, it
+    # is almost certain to represent a virtual mailbox
+    ALL = :All
+
+    # Mailbox attribute indicating that this mailbox is used to archive
+    # messages. The meaning of an "archival" mailbox is server dependent;
+    # typically, it will be used to get messages out of the inbox, or otherwise
+    # keep them out of the user's way, while still making them accessible
+    ARCHIVE = :Archive
+
+    # Mailbox attribute indicating that this mailbox is used to hold draft
+    # messages -- typically, messages that are being composed but have not yet
+    # been sent. In some server implementations, this might be a virtual
+    # mailbox, containing messages from other mailboxes that are marked with the
+    # "\Draft" message flag. Alternatively, this might just be advice that a
+    # client put drafts here
+    DRAFTS = :Drafts
+
+    # FLAGGED is defined with the system flags section.
+
+    # Mailbox attribute indicating that this mailbox is where messages deemed to
+    # be junk mail are held. Some server implementations might put messages here
+    # automatically.  Alternatively, this might just be advice to a client-side
+    # spam filter.
+    JUNK = :Junk
 
-    # Returns the max number of flags interned to symbols.
-    def self.max_flag_count
-      return @@max_flag_count
-    end
+    # Mailbox attribute indicating that this mailbox is used to hold copies of
+    # messages that have been sent. Some server implementations might put
+    # messages here automatically. Alternatively, this might just be advice that
+    # a client save sent messages here.
+    SENT = :Sent
 
-    # Sets the max number of flags interned to symbols.
-    def self.max_flag_count=(count)
-      @@max_flag_count = count
-    end
+    # Mailbox attribute indicating that this mailbox is used to hold messages
+    # that have been deleted or marked for deletion. In some server
+    # implementations, this might be a virtual mailbox, containing messages from
+    # other mailboxes that are marked with the "\Deleted" message flag.
+    # Alternatively, this might just be advice that a client that chooses not to
+    # use the IMAP "\Deleted" model should use as its trash location. In server
+    # implementations that strictly expect the IMAP "\Deleted" model, this
+    # special use is likely not to be supported.
+    TRASH = :Trash
 
   end
 end

data/lib/net/imap/response_parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "errors"
+
 module Net
   class IMAP < Protocol
 
@@ -9,7 +11,6 @@ module Net
         @pos = nil
         @lex_state = nil
         @token = nil
-        @flag_symbols = {}
       end
 
       def parse(str)
@@ -1212,12 +1213,7 @@ module Net
             if atom
               atom
             else
-              symbol = flag.capitalize.intern
-              @flag_symbols[symbol] = true
-              if @flag_symbols.length > IMAP.max_flag_count
-                raise FlagCountError, "number of flag symbols exceeded"
-              end
-              symbol
+              flag.capitalize.intern
             end
           }
         else

data/lib/net/imap.rb

@@ -13,7 +13,6 @@
 # See Net::IMAP for documentation.
 #
 
-
 require "socket"
 require "monitor"
 require 'net/protocol'
@@ -22,12 +21,6 @@ begin
 rescue LoadError
 end
 
-require_relative "imap/command_data"
-require_relative "imap/data_encoding"
-require_relative "imap/flags"
-require_relative "imap/response_data"
-require_relative "imap/response_parser"
-
 module Net
 
   #
@@ -227,7 +220,7 @@ module Net
   #    Unicode", RFC-2152[https://tools.ietf.org/html/rfc2152], May 1997.
   #
   class IMAP < Protocol
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
 
     include MonitorMixin
     if defined?(OpenSSL::SSL)
@@ -385,28 +378,37 @@ module Net
     # Sends an AUTHENTICATE command to authenticate the client.
     # The +auth_type+ parameter is a string that represents
     # the authentication mechanism to be used. Currently Net::IMAP
-    # supports the authentication mechanisms:
-    #
-    #   LOGIN:: login using cleartext user and password.
-    #   CRAM-MD5:: login with cleartext user and encrypted password
-    #              (see [RFC-2195] for a full description).  This
-    #              mechanism requires that the server have the user's
-    #              password stored in clear-text password.
-    #
-    # For both of these mechanisms, there should be two +args+: username
-    # and (cleartext) password.  A server may not support one or the other
-    # of these mechanisms; check #capability for a capability of
-    # the form "AUTH=LOGIN" or "AUTH=CRAM-MD5".
-    #
-    # Authentication is done using the appropriate authenticator object:
-    # see +add_authenticator+ for more information on plugging in your own
-    # authenticator.
+    # supports the following mechanisms:
+    #
+    # PLAIN:: Login using cleartext user and password.  Secure with TLS.
+    #         See Net::IMAP::PlainAuthenticator.
+    # CRAM-MD5::   DEPRECATED: Use PLAIN (or DIGEST-MD5) with TLS.
+    # DIGEST-MD5:: DEPRECATED by RFC6331. Must be secured using TLS.
+    #              See Net::IMAP::DigestMD5Authenticator.
+    # LOGIN::      DEPRECATED: Use PLAIN.
+    #
+    # Most mechanisms require two args: authentication identity (e.g. username)
+    # and credentials (e.g. a password).  But each mechanism requires and allows
+    # different arguments; please consult the documentation for the specific
+    # mechanisms you are using.  <em>Several obsolete mechanisms are available
+    # for backwards compatibility.  Using deprecated mechanisms will issue
+    # warnings.</em>
+    #
+    # Servers do not support all mechanisms and clients must not attempt to use
+    # a mechanism unless "AUTH=#{mechanism}" is listed as a #capability.
+    # Clients must not attempt to authenticate or #login when +LOGINDISABLED+ is
+    # listed with the capabilities.  Server capabilities, especially auth
+    # mechanisms, do change after calling #starttls so they need to be checked
+    # again.
     #
     # For example:
     #
-    #    imap.authenticate('LOGIN', user, password)
+    #    imap.authenticate('PLAIN', user, password)
     #
     # A Net::IMAP::NoResponseError is raised if authentication fails.
+    #
+    # See +Net::IMAP::Authenticators+ for more information on plugging in your
+    # own authenticator.
     def authenticate(auth_type, *args)
       authenticator = self.class.authenticator(auth_type, *args)
       send_command("AUTHENTICATE", auth_type) do |resp|
@@ -1462,118 +1464,13 @@ module Net
       end
     end
 
-    # Common validators of number and nz_number types
-    module NumValidator # :nodoc
-      class << self
-        # Check is passed argument valid 'number' in RFC 3501 terminology
-        def valid_number?(num)
-          # [RFC 3501]
-          # number          = 1*DIGIT
-          #                    ; Unsigned 32-bit integer
-          #                    ; (0 <= n < 4,294,967,296)
-          num >= 0 && num < 4294967296
-        end
-
-        # Check is passed argument valid 'nz_number' in RFC 3501 terminology
-        def valid_nz_number?(num)
-          # [RFC 3501]
-          # nz-number       = digit-nz *DIGIT
-          #                    ; Non-zero unsigned 32-bit integer
-          #                    ; (0 < n < 4,294,967,296)
-          num != 0 && valid_number?(num)
-        end
-
-        # Check is passed argument valid 'mod_sequence_value' in RFC 4551 terminology
-        def valid_mod_sequence_value?(num)
-          # mod-sequence-value  = 1*DIGIT
-          #                        ; Positive unsigned 64-bit integer
-          #                        ; (mod-sequence)
-          #                        ; (1 <= n < 18,446,744,073,709,551,615)
-          num >= 1 && num < 18446744073709551615
-        end
-
-        # Ensure argument is 'number' or raise DataFormatError
-        def ensure_number(num)
-          return if valid_number?(num)
-
-          msg = "number must be unsigned 32-bit integer: #{num}"
-          raise DataFormatError, msg
-        end
-
-        # Ensure argument is 'nz_number' or raise DataFormatError
-        def ensure_nz_number(num)
-          return if valid_nz_number?(num)
-
-          msg = "nz_number must be non-zero unsigned 32-bit integer: #{num}"
-          raise DataFormatError, msg
-        end
-
-        # Ensure argument is 'mod_sequence_value' or raise DataFormatError
-        def ensure_mod_sequence_value(num)
-          return if valid_mod_sequence_value?(num)
-
-          msg = "mod_sequence_value must be unsigned 64-bit integer: #{num}"
-          raise DataFormatError, msg
-        end
-      end
-    end
-
-    # Superclass of IMAP errors.
-    class Error < StandardError
-    end
-
-    # Error raised when data is in the incorrect format.
-    class DataFormatError < Error
-    end
-
-    # Error raised when a response from the server is non-parseable.
-    class ResponseParseError < Error
-    end
-
-    # Superclass of all errors used to encapsulate "fail" responses
-    # from the server.
-    class ResponseError < Error
-
-      # The response that caused this error
-      attr_accessor :response
-
-      def initialize(response)
-        @response = response
-
-        super @response.data.text
-      end
-
-    end
-
-    # Error raised upon a "NO" response from the server, indicating
-    # that the client command could not be completed successfully.
-    class NoResponseError < ResponseError
-    end
-
-    # Error raised upon a "BAD" response from the server, indicating
-    # that the client command violated the IMAP protocol, or an internal
-    # server failure has occurred.
-    class BadResponseError < ResponseError
-    end
-
-    # Error raised upon a "BYE" response from the server, indicating
-    # that the client is not being allowed to login, or has been timed
-    # out due to inactivity.
-    class ByeResponseError < ResponseError
-    end
-
-    # Error raised upon an unknown response from the server.
-    class UnknownResponseError < ResponseError
-    end
-
-    RESPONSE_ERRORS = Hash.new(ResponseError)
-    RESPONSE_ERRORS["NO"] = NoResponseError
-    RESPONSE_ERRORS["BAD"] = BadResponseError
-
-    # Error raised when too many flags are interned to symbols.
-    class FlagCountError < Error
-    end
   end
 end
 
+require_relative "imap/errors"
+require_relative "imap/command_data"
+require_relative "imap/data_encoding"
+require_relative "imap/flags"
+require_relative "imap/response_data"
+require_relative "imap/response_parser"
 require_relative "imap/authenticators"

data/net-imap.gemspec

@@ -10,13 +10,13 @@ end
 Gem::Specification.new do |spec|
   spec.name          = name
   spec.version       = version
-  spec.authors       = ["Shugo Maeda"]
-  spec.email         = ["shugo@ruby-lang.org"]
+  spec.authors       = ["Shugo Maeda", "nicholas a. evans"]
+  spec.email         = ["shugo@ruby-lang.org", "nick@ekenosen.net"]
 
   spec.summary       = %q{Ruby client api for Internet Message Access Protocol}
   spec.description   = %q{Ruby client api for Internet Message Access Protocol}
   spec.homepage      = "https://github.com/ruby/net-imap"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
   spec.licenses       = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -25,13 +25,13 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "net-protocol"
-  spec.add_dependency "digest"
-  spec.add_dependency "strscan"
+  spec.add_development_dependency "digest"
+  spec.add_development_dependency "strscan"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Shugo Maeda
+- nicholas a. evans
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -31,7 +32,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +46,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -55,18 +56,18 @@ dependencies:
 description: Ruby client api for Internet Message Access Protocol
 email:
 - shugo@ruby-lang.org
+- nick@ekenosen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/net/imap.rb
 - lib/net/imap/authenticators.rb
 - lib/net/imap/authenticators/cram_md5.rb
@@ -75,6 +76,7 @@ files:
 - lib/net/imap/authenticators/plain.rb
 - lib/net/imap/command_data.rb
 - lib/net/imap/data_encoding.rb
+- lib/net/imap/errors.rb
 - lib/net/imap/flags.rb
 - lib/net/imap/response_data.rb
 - lib/net/imap/response_parser.rb
@@ -94,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Ruby client api for Internet Message Access Protocol

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "net/imap"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here