class Net::IMAP::Config

Net::IMAP::Config (自 v0.4.13 起可用) 存储 Net::IMAP 客户端的配置选项。全局配置可以在 Net::IMAP.config 或 Net::IMAP::Config.global 中查看，而客户端特定的配置可以在 Net::IMAP#config 中查看。

创建新客户端时，传递给 Net::IMAP.new 的所有未处理的关键字参数都会委托给 Config.new。每个客户端都有自己的配置。

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

继承¶ ↑

配置具有 父配置，任何未在本地设置的属性都将继承父类的值。每个客户端都会创建自己的特定配置。默认情况下，客户端配置继承自 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

版本化默认值¶ ↑

可以使用 Net::IMAP.new 的 config 关键字参数加载特定 net-imap 的 x.y 版本的有效默认配置。请求先前版本的默认配置可以实现与这些版本的额外向后兼容性。

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  # => :raise

版本化的默认配置从 Config.global 继承某些特定的配置选项，例如 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

使用 load_defaults 来全局表现得像特定版本一样

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

命名默认值¶ ↑

除了 x.y 版本号，还支持以下别名

:default

:current 的别名。

注意：这与 Config.default 不同。它从 Config.global 继承一些属性，例如：debug。

:current

当前 x.y 版本的默认值的别名。

:next

下一个 x.y 版本的计划配置。

:future

未来某个 x.y 版本的计划最终配置。

例如，要为所有当前的弃用引发异常

client = Net::IMAP.new(hostname, config: :future)
client.responses  # raises an ArgumentError

线程安全¶ ↑

注意： 对配置对象的更新不会针对线程安全进行同步。