class Net::IMAP::Config

Net::IMAP::Config (available since v0.4.13) stores configuration options for Net::IMAP clients. The global configuration can be seen at either Net::IMAP.config or Net::IMAP::Config.global, and the client-specific configuration can be seen at Net::IMAP#config.

When creating a new client, all unhandled keyword arguments to Net::IMAP.new are delegated to Config.new. Every client has its own config.

debug_client = Net::IMAP.new(hostname, debug: true)
quiet_client = Net::IMAP.new(hostname, debug: false)
debug_client.config.debug?  # => true
quiet_client.config.debug?  # => false

Inheritance

Configs have a parent config, and any attributes which have not been set locally will inherit the parent’s value. Every client creates its own specific config. By default, client configs inherit from Config.global.

plain_client = Net::IMAP.new(hostname)
debug_client = Net::IMAP.new(hostname, debug: true)
quiet_client = Net::IMAP.new(hostname, debug: false)

plain_client.config.inherited?(:debug)  # => true
debug_client.config.inherited?(:debug)  # => false
quiet_client.config.inherited?(:debug)  # => false

plain_client.config.debug?  # => false
debug_client.config.debug?  # => true
quiet_client.config.debug?  # => false

# Net::IMAP.debug is delegated to Net::IMAP::Config.global.debug
Net::IMAP.debug = true
plain_client.config.debug?  # => true
debug_client.config.debug?  # => true
quiet_client.config.debug?  # => false

Net::IMAP.debug = false
plain_client.config.debug = true
plain_client.config.inherited?(:debug)  # => false
plain_client.config.debug?  # => true
plain_client.config.reset(:debug)
plain_client.config.inherited?(:debug)  # => true
plain_client.config.debug?  # => false

Versioned defaults

The effective default configuration for a specific x.y version of net-imap can be loaded with the config keyword argument to Net::IMAP.new. Requesting default configurations for previous versions enables extra backward compatibility with those versions:

client = Net::IMAP.new(hostname, config: 0.3)
client.config.sasl_ir                  # => false
client.config.responses_without_block  # => :silence_deprecation_warning

client = Net::IMAP.new(hostname, config: 0.4)
client.config.sasl_ir                  # => true
client.config.responses_without_block  # => :silence_deprecation_warning

client = Net::IMAP.new(hostname, config: 0.5)
client.config.sasl_ir                  # => true
client.config.responses_without_block  # => :warn

client = Net::IMAP.new(hostname, config: :future)
client.config.sasl_ir                  # => true
client.config.responses_without_block  # => :frozen_dup

The versioned default configs inherit certain specific config options from Config.global, for example #debug:

client = Net::IMAP.new(hostname, config: 0.4)
Net::IMAP.debug = false
client.config.debug?  # => false

Net::IMAP.debug = true
client.config.debug?  # => true

Use load_defaults to globally behave like a specific version:

client = Net::IMAP.new(hostname)
client.config.sasl_ir              # => true
Net::IMAP.config.load_defaults 0.3
client.config.sasl_ir              # => false

Named defaults

In addition to x.y version numbers, the following aliases are supported:

:default: An alias for :current.

NOTE: This is not the same as Config.default. It inherits some attributes from Config.global, for example: #debug.
:current: An alias for the current x.y version’s defaults.
:next: The planned config for the next x.y version.
:future: The planned eventual config for some future x.y version.

For example, to disable all currently deprecated behavior:

client = Net::IMAP.new(hostname, config: :future)
client.config.response_without_args     # => :frozen_dup
client.responses.frozen?                # => true
client.responses.values.all?(&:frozen?) # => true

Thread Safety

NOTE: Updates to config objects are not synchronized for thread-safety.

Attributes

responses_without_args [RW]

Alias for responses_without_block

Public Class Methods

Net::IMAP::Config[number] → versioned config

Net::IMAP::Config[symbol] → named config

Net::IMAP::Config[hash] → new frozen config

Net::IMAP::Config[config] → same config

Source

# File lib/net/imap/config.rb, line 163
def self.[](config)
  if    config.is_a?(Config)         then config
  elsif config.nil? && global.nil?   then nil
  elsif config.respond_to?(:to_hash) then new(global, **config).freeze
  else
    version_defaults[config] or
      case config
      when Numeric
        raise RangeError, "unknown config version: %p" % [config]
      when String, Symbol
        raise KeyError, "unknown config name: %p" % [config]
      else
        raise TypeError, "no implicit conversion of %s to %s" % [
          config.class, Config
        ]
      end
  end
end

Given a version number, returns the default configuration for the target version. See Versioned defaults at Config.

Given a version name, returns the default configuration for the target version. See Named defaults at Config.

Given a Hash, creates a new frozen config which inherits from Config.global. Use Config.new for an unfrozen config.

Given a config, returns that same config.

default

Source

# File lib/net/imap/config.rb, line 129
def self.default; @default end

The default config, which is hardcoded and frozen.

global

Source

# File lib/net/imap/config.rb, line 132
def self.global; @global if defined?(@global) end

The global config object. Also available from Net::IMAP.config.

new (parent = Config.global, **attrs) { |self| ... }

Source

# File lib/net/imap/config.rb, line 466
def initialize(parent = Config.global, **attrs)
  super(parent)
  update(**attrs)
  yield self if block_given?
end

Creates a new config object and initialize its attribute with attrs.

If parent is not given, the global config is used by default.

If a block is given, the new config object is yielded to it.

Calls superclass method Net::IMAP::Config::AttrInheritance#new

version_defaults

Source

# File lib/net/imap/config.rb, line 145
def self.version_defaults; AttrVersionDefaults.version_defaults end

A hash of hard-coded configurations, indexed by version number or name. Values can be accessed with any object that responds to to_sym or to_r/to_f with a non-zero number.

Config::[] gets named or numbered versions from this hash.

For example:

Net::IMAP::Config.version_defaults[0.5] == Net::IMAP::Config[0.5]
Net::IMAP::Config[0.5]       == Net::IMAP::Config[0.5r]     # => true
Net::IMAP::Config["current"] == Net::IMAP::Config[:current] # => true
Net::IMAP::Config["0.5.6"]   == Net::IMAP::Config[0.5r]     # => true

Public Instance Methods

inspect

Source

# File lib/net/imap/config.rb, line 570
def inspect;
  "#<#{inspect_recursive}>"
end

Returns a string representation of overriden config attributes and the inheritance chain.

Attributes overridden by ancestors are also inspected, recursively. Attributes that are inherited from default configs are not shown (see Versioned defaults at Config and Named defaults at Config).

# (Line breaks have been added to the example output for legibility.)

Net::IMAP::Config.new(0.4)
  .new(open_timeout: 10, enforce_logindisabled: true)
  .inspect
#=> "#<Net::IMAP::Config:0x0000745871125410 open_timeout=10 enforce_logindisabled=true
#      inherits from Net::IMAP::Config[0.4]
#      inherits from Net::IMAP::Config.global
#      inherits from Net::IMAP::Config.default>"

Non-default attributes are listed after the ancestor config from which they are inherited.

# (Line breaks have been added to the example output for legibility.)

config = Net::IMAP::Config.global
  .new(open_timeout: 10, idle_response_timeout: 2)
  .new(enforce_logindisabled: :when_capabilities_cached, sasl_ir: false)
config.inspect
#=> "#<Net::IMAP::Config:0x00007ce2a1e20e40 sasl_ir=false enforce_logindisabled=:when_capabilities_cached
#      inherits from Net::IMAP::Config:0x00007ce2a1e20f80 open_timeout=10 idle_response_timeout=2
#      inherits from Net::IMAP::Config.global
#      inherits from Net::IMAP::Config.default>"

Net::IMAP.debug = true
config.inspect
#=> "#<Net::IMAP::Config:0x00007ce2a1e20e40 sasl_ir=false enforce_logindisabled=:when_capabilities_cached
#      inherits from Net::IMAP::Config:0x00007ce2a1e20f80 open_timeout=10 idle_response_timeout=2
#      inherits from Net::IMAP::Config.global debug=true
#      inherits from Net::IMAP::Config.default>"

Use pp (see pretty_print) to inspect all config attributes, including default values.

Use to_h to inspect all config attributes ignoring inheritance.

Also aliased as: to_s

load_defaults(version) → self

Source

# File lib/net/imap/config.rb, line 517
def load_defaults(version)
  [Numeric, Symbol, String].any? { _1 === version } or
    raise ArgumentError, "expected number or symbol, got %p" % [version]
  update(**Config[version].defaults_hash)
end

Resets the current config to behave like the versioned default configuration for version. parent will not be changed.

Some config attributes default to inheriting from their parent (which is usually Config.global) and are left unchanged, for example: #debug.

See Versioned defaults at Config and Named defaults at Config.

pretty_print (pp)

Source

# File lib/net/imap/config.rb, line 596
def pretty_print(pp)
  pp.group(2, "#<", ">") do
    pretty_print_recursive(pp)
  end
end

Used by PP to create a string representation of all config attributes and the inheritance chain. Inherited attributes are listed with the ancestor config from which they are inherited.

pp Config.new[0.4].new(open_timeout: 10, idle_response_timeout: 10)
# #<Net::IMAP::Config:0x0000745871125410
#   open_timeout=10
#   idle_response_timeout=10
#   inherits from Net::IMAP::Config[0.4]
#     responses_without_block=:silence_deprecation_warning
#     max_response_size=nil
#     sasl_ir=true
#     enforce_logindisabled=false
#     parser_use_deprecated_uidplus_data=true
#     parser_max_deprecated_uidplus_data_size=1000
#     inherits from Net::IMAP::Config.global
#       inherits from Net::IMAP::Config.default
#         debug=false>

Related: inspect, to_h.

to_h → hash

Source

# File lib/net/imap/config.rb, line 526
def to_h; data.members.to_h { [_1, send(_1)] } end

Returns all config attributes in a hash.

to_s

Alias for: inspect

update(**attrs) → self

Source

# File lib/net/imap/config.rb, line 482
def update(**attrs)
  unless (bad = attrs.keys.reject { respond_to?(:"#{_1}=") }).empty?
    raise ArgumentError, "invalid config options: #{bad.join(", ")}"
  end
  attrs.each do send(:"#{_1}=", _2) end
  self
end

Assigns all of the provided attrs to this config, and returns self.

An ArgumentError is raised unless every key in attrs matches an assignment method on Config.

NOTE: update is not atomic. If an exception is raised due to an invalid attribute value, attrs may be partially applied.

with(**attrs) → config

with(**attrs) {|config| } → result

Source

# File lib/net/imap/config.rb, line 500
def with(**attrs)
  attrs.empty? and
    raise ArgumentError, "expected keyword arguments, none given"
  copy = new(**attrs)
  copy.freeze if frozen?
  block_given? ? yield(copy) : copy
end

Without a block, returns a new config which inherits from self. With a block, yields the new config and returns the block’s result.

If no keyword arguments are given, an ArgumentError will be raised.

If self is frozen, the copy will also be frozen.