Class: Mailscope::Configuration
- Inherits:
-
Object
- Object
- Mailscope::Configuration
- Defined in:
- lib/mailscope/configuration.rb
Overview
Runtime configuration. Set through Mailscope.configure.
Instance Attribute Summary collapse
-
#authenticate_with ⇒ Object
Callable receiving the ActionDispatch::Request.
-
#auto_refresh ⇒ Object
Polling for newly delivered mail, in the browser.
-
#auto_refresh_interval ⇒ Object
Polling for newly delivered mail, in the browser.
-
#block_remote_content ⇒ Object
Default state of the "block remote content" switch in the preview pane.
-
#default_theme ⇒ Object
:system, :light or :dark.
-
#location ⇒ Object
(also: #letters_location)
Where captured mail is stored.
-
#max_age ⇒ Object
Retention.
-
#max_letters ⇒ Object
Retention.
-
#preview_widths ⇒ Object
Widths offered by the viewport switcher, in CSS pixels.
-
#storage ⇒ Object
Storage adapter: a symbol registered in Mailscope::Storage, or an object responding to the Mailscope::Storage::Base interface.
-
#title ⇒ Object
Shown in the header and the
.</p></div></span> </li> </ul> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Configuration </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Configuration.</p></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Mailscope::Configuration (class)">Configuration</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Configuration.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 36 37 38 39 40 41 42 43 44 45 46 47 48</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 36</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_default_location'>default_location</span> <span class='ivar'>@storage</span> <span class='op'>=</span> <span class='symbol'>:filesystem</span> <span class='ivar'>@max_letters</span> <span class='op'>=</span> <span class='int'>500</span> <span class='ivar'>@max_age</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='ivar'>@authenticate_with</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='ivar'>@block_remote_content</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='ivar'>@auto_refresh</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='ivar'>@auto_refresh_interval</span> <span class='op'>=</span> <span class='int'>3</span> <span class='ivar'>@default_theme</span> <span class='op'>=</span> <span class='symbol'>:system</span> <span class='ivar'>@title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Mailscope</span><span class='tstring_end'>'</span></span> <span class='ivar'>@preview_widths</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Desktop</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Tablet</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='int'>768</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Mobile</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='int'>390</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="authenticate_with=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="authenticate_with-instance_method"> #<strong>authenticate_with</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Callable receiving the ActionDispatch::Request. Return a falsy value to deny access. Nil means the UI is open to anyone who can reach the route.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 18 19 20</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 18</span> <span class='kw'>def</span> <span class='id identifier rubyid_authenticate_with'>authenticate_with</span> <span class='ivar'>@authenticate_with</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="auto_refresh=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="auto_refresh-instance_method"> #<strong>auto_refresh</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Polling for newly delivered mail, in the browser. Off by default: the user turns it on from the header and the choice sticks per browser.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_auto_refresh'>auto_refresh</span> <span class='ivar'>@auto_refresh</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="auto_refresh_interval=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="auto_refresh_interval-instance_method"> #<strong>auto_refresh_interval</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Polling for newly delivered mail, in the browser. Off by default: the user turns it on from the header and the choice sticks per browser.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_auto_refresh_interval'>auto_refresh_interval</span> <span class='ivar'>@auto_refresh_interval</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="block_remote_content=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="block_remote_content-instance_method"> #<strong>block_remote_content</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Default state of the "block remote content" switch in the preview pane.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_block_remote_content'>block_remote_content</span> <span class='ivar'>@block_remote_content</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="default_theme=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="default_theme-instance_method"> #<strong>default_theme</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>:system, :light or :dark. The user can override it in the UI.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 28 29 30</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_default_theme'>default_theme</span> <span class='ivar'>@default_theme</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="location=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="location-instance_method"> #<strong>location</strong> ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='letters_location-instance_method'>letters_location</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Where captured mail is stored. Accepts anything Pathname() understands.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 7 8 9</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 7</span> <span class='kw'>def</span> <span class='id identifier rubyid_location'>location</span> <span class='ivar'>@location</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="max_age=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="max_age-instance_method"> #<strong>max_age</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Retention. Both are applied after every delivery; nil disables the check.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 14 15 16</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_max_age'>max_age</span> <span class='ivar'>@max_age</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="max_letters=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="max_letters-instance_method"> #<strong>max_letters</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Retention. Both are applied after every delivery; nil disables the check.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 14 15 16</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_max_letters'>max_letters</span> <span class='ivar'>@max_letters</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="preview_widths=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="preview_widths-instance_method"> #<strong>preview_widths</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Widths offered by the viewport switcher, in CSS pixels.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 34 35 36</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 34</span> <span class='kw'>def</span> <span class='id identifier rubyid_preview_widths'>preview_widths</span> <span class='ivar'>@preview_widths</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="storage=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="storage-instance_method"> #<strong>storage</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Storage adapter: a symbol registered in Mailscope::Storage, or an object responding to the Mailscope::Storage::Base interface.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 11 12 13</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 11</span> <span class='kw'>def</span> <span class='id identifier rubyid_storage'>storage</span> <span class='ivar'>@storage</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="title=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="title-instance_method"> #<strong>title</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Shown in the header and the <title>.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 31 32 33</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mailscope/configuration.rb', line 31</span> <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span> <span class='ivar'>@title</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sat Aug 22 23:38:42 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.2). </div> </div> </body> </html>