PageRenderTime 26ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/api/classes/ActionMailer/MailHelper.html

https://gitlab.com/ability-list-inc/abilitylist
HTML | 355 lines | 204 code | 149 blank | 2 comment | 0 complexity | 725c02fac6f79796bb0658e7ba2e59c7 MD5 | raw file
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.     <title>ActionMailer::MailHelper</title>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    8. 

  8.     <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
    9. 

  9. <link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
    10. 

  10. <link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
    11. 

  11. <script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    12. 

  12. <script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    13. 

  13. <script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
    14. 

  14. <script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
    15. 

  15. 

  16. </head>
    17. 

  17. 

  18. <body>     
    19. 

  19.     <div class="banner">
    20. 

  20.         
    21. 

  21.             <span>Ruby on Rails 4.2.0</span><br />
    22. 

  22.         
    23. 

  23.         <h1>
    24. 

  24.             <span class="type">Module</span> 
    25. 

  25.             ActionMailer::MailHelper 
    26. 

  26.             
    27. 

  27.         </h1>
    28. 

  28.         <ul class="files">
    29. 

  29.             
    30. 

  30.             <li><a href="../../files/__/__/_rvm/gems/ruby-2_2_0@global/gems/actionmailer-4_2_0/lib/action_mailer/mail_helper_rb.html">/Users/az/.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb</a></li>
    31. 

  31.             
    32. 

  32.         </ul>
    33. 

  33.     </div>
    34. 

  34.     <div id="bodyContent">
    35. 

  35.         <div id="content">
    36. 

  36.   
    37. 

  37.     <div class="description">
    38. 

  38.       
    39. 

  39. <p>Provides helper methods for <a href="Base.html">ActionMailer::Base</a> that
    40. 

  40. can be used for easily formatting messages, accessing mailer or message
    41. 

  41. instances, and the attachments list.</p>
    42. 

  42. 

  43.     </div>
    44. 

  44.   
    45. 

  45. 

  46. 

  47.   
    48. 

  48. 

  49. 

  50.   
    51. 

  51.   
    52. 

  52. 

  53. 

  54.   
    55. 

  55. 

  56. 

  57.   
    58. 

  58.     <!-- Method ref -->
    59. 

  59.     <div class="sectiontitle">Methods</div>
    60. 

  60.     <dl class="methods">
    61. 

  61.       
    62. 

  62.         <dt>A</dt>
    63. 

  63.         <dd>
    64. 

  64.           <ul>
    65. 

  65.             
    66. 

  66.               
    67. 

  67.               <li>
    68. 

  68.                 <a href="#method-i-attachments">attachments</a>
    69. 

  69.               </li>
    70. 

  70.             
    71. 

  71.           </ul>
    72. 

  72.         </dd>
    73. 

  73.       
    74. 

  74.         <dt>B</dt>
    75. 

  75.         <dd>
    76. 

  76.           <ul>
    77. 

  77.             
    78. 

  78.               
    79. 

  79.               <li>
    80. 

  80.                 <a href="#method-i-block_format">block_format</a>
    81. 

  81.               </li>
    82. 

  82.             
    83. 

  83.           </ul>
    84. 

  84.         </dd>
    85. 

  85.       
    86. 

  86.         <dt>F</dt>
    87. 

  87.         <dd>
    88. 

  88.           <ul>
    89. 

  89.             
    90. 

  90.               
    91. 

  91.               <li>
    92. 

  92.                 <a href="#method-i-format_paragraph">format_paragraph</a>
    93. 

  93.               </li>
    94. 

  94.             
    95. 

  95.           </ul>
    96. 

  96.         </dd>
    97. 

  97.       
    98. 

  98.         <dt>M</dt>
    99. 

  99.         <dd>
    100. 

  100.           <ul>
    101. 

  101.             
    102. 

  102.               
    103. 

  103.               <li>
    104. 

  104.                 <a href="#method-i-mailer">mailer</a>,
    105. 

  105.               </li>
    106. 

  106.             
    107. 

  107.               
    108. 

  108.               <li>
    109. 

  109.                 <a href="#method-i-message">message</a>
    110. 

  110.               </li>
    111. 

  111.             
    112. 

  112.           </ul>
    113. 

  113.         </dd>
    114. 

  114.       
    115. 

  115.     </dl>
    116. 

  116.   
    117. 

  117. 

  118.   
    119. 

  119. 

  120. 

  121. 

  122.   
    123. 

  123. 

  124.     
    125. 

  125. 

  126.     
    127. 

  127. 

  128.     
    129. 

  129. 

  130. 

  131.     
    132. 

  132. 

  133. 

  134.     <!-- Methods -->
    135. 

  135.         
    136. 

  136.       <div class="sectiontitle">Instance Public methods</div>
    137. 

  137.       
    138. 

  138.         <div class="method">
    139. 

  139.           <div class="title method-title" id="method-i-attachments">
    140. 

  140.             
    141. 

  141.               <b>attachments</b>()
    142. 

  142.             
    143. 

  143.             <a href="../../classes/ActionMailer/MailHelper.html#method-i-attachments" name="method-i-attachments" class="permalink">Link</a>
    144. 

  144.           </div>
    145. 

  145.           
    146. 

  146.           
    147. 

  147.             <div class="description">
    148. 

  148.               <p>Access the message attachments list.</p>
    149. 

  149.             </div>
    150. 

  150.           
    151. 

  151.           
    152. 

  152.           
    153. 

  153. 

  154.           
    155. 

  155.           
    156. 

  156.           
    157. 

  157.             
    158. 

  158.             <div class="sourcecode">
    159. 

  159.               
    160. 

  160.               <p class="source-link">
    161. 

  161.                 Source: 
    162. 

  162.                 <a href="javascript:toggleSource('method-i-attachments_source')" id="l_method-i-attachments_source">show</a>
    163. 

  163.                 
    164. 

  164.               </p>
    165. 

  165.               <div id="method-i-attachments_source" class="dyn-source">
    166. 

  166.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb, line 31</span>
    167. 

  167. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">attachments</span>
    168. 

  168.   <span class="ruby-identifier">mailer</span>.<span class="ruby-identifier">attachments</span>
    169. 

  169. <span class="ruby-keyword">end</span></pre>
    170. 

  170.               </div>
    171. 

  171.             </div>
    172. 

  172.             
    173. 

  173.           </div>
    174. 

  174.         
    175. 

  175.         <div class="method">
    176. 

  176.           <div class="title method-title" id="method-i-block_format">
    177. 

  177.             
    178. 

  178.               <b>block_format</b>(text)
    179. 

  179.             
    180. 

  180.             <a href="../../classes/ActionMailer/MailHelper.html#method-i-block_format" name="method-i-block_format" class="permalink">Link</a>
    181. 

  181.           </div>
    182. 

  182.           
    183. 

  183.           
    184. 

  184.             <div class="description">
    185. 

  185.               <p>Take the text and format it, indented two spaces for each line, and wrapped
    186. 

  186. at 72 columns.</p>
    187. 

  187.             </div>
    188. 

  188.           
    189. 

  189.           
    190. 

  190.           
    191. 

  191. 

  192.           
    193. 

  193.           
    194. 

  194.           
    195. 

  195.             
    196. 

  196.             <div class="sourcecode">
    197. 

  197.               
    198. 

  198.               <p class="source-link">
    199. 

  199.                 Source: 
    200. 

  200.                 <a href="javascript:toggleSource('method-i-block_format_source')" id="l_method-i-block_format_source">show</a>
    201. 

  201.                 
    202. 

  202.               </p>
    203. 

  203.               <div id="method-i-block_format_source" class="dyn-source">
    204. 

  204.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb, line 8</span>
    205. 

  205. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">block_format</span>(<span class="ruby-identifier">text</span>)
    206. 

  206.   <span class="ruby-identifier">formatted</span> = <span class="ruby-identifier">text</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\n\r?\n/</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">paragraph</span><span class="ruby-operator">|</span>
    207. 

  207.     <span class="ruby-identifier">format_paragraph</span>(<span class="ruby-identifier">paragraph</span>)
    208. 

  208.   }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n\n&quot;</span>)
    209. 

  209. 

  210.   <span class="ruby-comment"># Make list points stand on their own line</span>
    211. 

  211.   <span class="ruby-identifier">formatted</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/[ ]*([*]+) ([^*]*)/</span>) { <span class="ruby-node">&quot;  #{$1} #{$2.strip}\n&quot;</span> }
    212. 

  212.   <span class="ruby-identifier">formatted</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-node">/[ ]*([#]+) ([^#]*)/</span>) { <span class="ruby-node">&quot;  #{$1} #{$2.strip}\n&quot;</span> }
    213. 

  213. 

  214.   <span class="ruby-identifier">formatted</span>
    215. 

  215. <span class="ruby-keyword">end</span></pre>
    216. 

  216.               </div>
    217. 

  217.             </div>
    218. 

  218.             
    219. 

  219.           </div>
    220. 

  220.         
    221. 

  221.         <div class="method">
    222. 

  222.           <div class="title method-title" id="method-i-format_paragraph">
    223. 

  223.             
    224. 

  224.               <b>format_paragraph</b>(text, len = 72, indent = 2)
    225. 

  225.             
    226. 

  226.             <a href="../../classes/ActionMailer/MailHelper.html#method-i-format_paragraph" name="method-i-format_paragraph" class="permalink">Link</a>
    227. 

  227.           </div>
    228. 

  228.           
    229. 

  229.           
    230. 

  230.             <div class="description">
    231. 

  231.               <p>Returns <code>text</code> wrapped at <code>len</code> columns and indented
    232. 

  232. <code>indent</code> spaces.</p>
    233. 

  233. 

  234. <pre><code>my_text = &#39;Here is a sample text with more than 40 characters&#39;
    235. 

  235. 

  236. format_paragraph(my_text, 25, 4)
    237. 

  237. # =&gt; &quot;    Here is a sample text with\n    more than 40 characters&quot;
    238. 

  238. </code></pre>
    239. 

  239.             </div>
    240. 

  240.           
    241. 

  241.           
    242. 

  242.           
    243. 

  243. 

  244.           
    245. 

  245.           
    246. 

  246.           
    247. 

  247.             
    248. 

  248.             <div class="sourcecode">
    249. 

  249.               
    250. 

  250.               <p class="source-link">
    251. 

  251.                 Source: 
    252. 

  252.                 <a href="javascript:toggleSource('method-i-format_paragraph_source')" id="l_method-i-format_paragraph_source">show</a>
    253. 

  253.                 
    254. 

  254.               </p>
    255. 

  255.               <div id="method-i-format_paragraph_source" class="dyn-source">
    256. 

  256.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb, line 41</span>
    257. 

  257. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">format_paragraph</span>(<span class="ruby-identifier">text</span>, <span class="ruby-identifier">len</span> = <span class="ruby-number">72</span>, <span class="ruby-identifier">indent</span> = <span class="ruby-number">2</span>)
    258. 

  258.   <span class="ruby-identifier">sentences</span> = [[]]
    259. 

  259. 

  260.   <span class="ruby-identifier">text</span>.<span class="ruby-identifier">split</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">word</span><span class="ruby-operator">|</span>
    261. 

  261.     <span class="ruby-keyword">if</span> <span class="ruby-identifier">sentences</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">present?</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">sentences</span>.<span class="ruby-identifier">last</span> <span class="ruby-operator">+</span> [<span class="ruby-identifier">word</span>]).<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>).<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">len</span>
    262. 

  262.       <span class="ruby-identifier">sentences</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">word</span>]
    263. 

  263.     <span class="ruby-keyword">else</span>
    264. 

  264.       <span class="ruby-identifier">sentences</span>.<span class="ruby-identifier">last</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">word</span>
    265. 

  265.     <span class="ruby-keyword">end</span>
    266. 

  266.   <span class="ruby-keyword">end</span>
    267. 

  267. 

  268.   <span class="ruby-identifier">indentation</span> = <span class="ruby-string">&quot; &quot;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">indent</span>
    269. 

  269.   <span class="ruby-identifier">sentences</span>.<span class="ruby-identifier">map!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">sentence</span><span class="ruby-operator">|</span>
    270. 

  270.     <span class="ruby-node">&quot;#{indentation}#{sentence.join(&#39; &#39;)}&quot;</span>
    271. 

  271.   }.<span class="ruby-identifier">join</span> <span class="ruby-string">&quot;\n&quot;</span>
    272. 

  272. <span class="ruby-keyword">end</span></pre>
    273. 

  273.               </div>
    274. 

  274.             </div>
    275. 

  275.             
    276. 

  276.           </div>
    277. 

  277.         
    278. 

  278.         <div class="method">
    279. 

  279.           <div class="title method-title" id="method-i-mailer">
    280. 

  280.             
    281. 

  281.               <b>mailer</b>()
    282. 

  282.             
    283. 

  283.             <a href="../../classes/ActionMailer/MailHelper.html#method-i-mailer" name="method-i-mailer" class="permalink">Link</a>
    284. 

  284.           </div>
    285. 

  285.           
    286. 

  286.           
    287. 

  287.             <div class="description">
    288. 

  288.               <p>Access the mailer instance.</p>
    289. 

  289.             </div>
    290. 

  290.           
    291. 

  291.           
    292. 

  292.           
    293. 

  293. 

  294.           
    295. 

  295.           
    296. 

  296.           
    297. 

  297.             
    298. 

  298.             <div class="sourcecode">
    299. 

  299.               
    300. 

  300.               <p class="source-link">
    301. 

  301.                 Source: 
    302. 

  302.                 <a href="javascript:toggleSource('method-i-mailer_source')" id="l_method-i-mailer_source">show</a>
    303. 

  303.                 
    304. 

  304.               </p>
    305. 

  305.               <div id="method-i-mailer_source" class="dyn-source">
    306. 

  306.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb, line 21</span>
    307. 

  307. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">mailer</span>
    308. 

  308.   <span class="ruby-ivar">@_controller</span>
    309. 

  309. <span class="ruby-keyword">end</span></pre>
    310. 

  310.               </div>
    311. 

  311.             </div>
    312. 

  312.             
    313. 

  313.           </div>
    314. 

  314.         
    315. 

  315.         <div class="method">
    316. 

  316.           <div class="title method-title" id="method-i-message">
    317. 

  317.             
    318. 

  318.               <b>message</b>()
    319. 

  319.             
    320. 

  320.             <a href="../../classes/ActionMailer/MailHelper.html#method-i-message" name="method-i-message" class="permalink">Link</a>
    321. 

  321.           </div>
    322. 

  322.           
    323. 

  323.           
    324. 

  324.             <div class="description">
    325. 

  325.               <p>Access the message instance.</p>
    326. 

  326.             </div>
    327. 

  327.           
    328. 

  328.           
    329. 

  329.           
    330. 

  330. 

  331.           
    332. 

  332.           
    333. 

  333.           
    334. 

  334.             
    335. 

  335.             <div class="sourcecode">
    336. 

  336.               
    337. 

  337.               <p class="source-link">
    338. 

  338.                 Source: 
    339. 

  339.                 <a href="javascript:toggleSource('method-i-message_source')" id="l_method-i-message_source">show</a>
    340. 

  340.                 
    341. 

  341.               </p>
    342. 

  342.               <div id="method-i-message_source" class="dyn-source">
    343. 

  343.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0@global/gems/actionmailer-4.2.0/lib/action_mailer/mail_helper.rb, line 26</span>
    344. 

  344. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">message</span>
    345. 

  345.   <span class="ruby-ivar">@_message</span>
    346. 

  346. <span class="ruby-keyword">end</span></pre>
    347. 

  347.               </div>
    348. 

  348.             </div>
    349. 

  349.             
    350. 

  350.           </div>
    351. 

  351.                     </div>
    352. 

  352. 

  353.     </div>
    354. 

  354.   </body>
    355. 

  355. </html>    
    356.