-
Notifications
You must be signed in to change notification settings - Fork 0
/
action_mailer_basics.html
1214 lines (1131 loc) · 105 KB
/
action_mailer_basics.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html dir="ltr" lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Conceptos Básicos de Action Mailer — Ruby on Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style-v2.css" data-turbo-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/print-v2.css" media="print">
<link rel="stylesheet" type="text/css" href="stylesheets/highlight-v2.css" data-turbo-track="reload">
<link rel="icon" href="images/favicon.ico" sizes="any">
<link rel="apple-touch-icon" href="images/icon.png">
<script src="javascripts/@hotwired--turbo.js" data-turbo-track="reload"></script>
<script src="javascripts/clipboard.js" data-turbo-track="reload"></script>
<script src="javascripts/guides.js" data-turbo-track="reload"></script>
<meta property="og:title" content="Conceptos Básicos de Action Mailer — Ruby on Rails Guides" />
<meta name="description" content="NO LEA ESTE ARCHIVO EN GITHUB, LAS GUÍAS ESTÁN PUBLICADAS EN https://guides.rubyonrails.org.Conceptos Básicos de Action MailerEsta guía te proporciona todo lo que necesitas para comenzar a enviar correos electrónicos desde tu aplicación y muchos aspectos internos de Action Mailer. También cubre cómo probar tus mailers.Después de leer esta guía, sabrás: Cómo enviar correos electrónicos dentro de una aplicación Rails. Cómo generar y editar una clase de Action Mailer y una vista de mailer. Cómo configurar Action Mailer para tu entorno. Cómo probar tus clases de Action Mailer." />
<meta property="og:description" content="NO LEA ESTE ARCHIVO EN GITHUB, LAS GUÍAS ESTÁN PUBLICADAS EN https://guides.rubyonrails.org.Conceptos Básicos de Action MailerEsta guía te proporciona todo lo que necesitas para comenzar a enviar correos electrónicos desde tu aplicación y muchos aspectos internos de Action Mailer. También cubre cómo probar tus mailers.Después de leer esta guía, sabrás: Cómo enviar correos electrónicos dentro de una aplicación Rails. Cómo generar y editar una clase de Action Mailer y una vista de mailer. Cómo configurar Action Mailer para tu entorno. Cómo probar tus clases de Action Mailer." />
<meta property="og:locale" content="en_US" />
<meta property="og:site_name" content="Ruby on Rails Guides" />
<meta property="og:image" content="https://avatars.githubusercontent.com/u/4223" />
<meta property="og:type" content="website" />
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans+Arabic:[email protected]&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Heebo:[email protected]&family=Noto+Sans+Arabic:[email protected]&display=swap" rel="stylesheet">
<meta name="theme-color" content="#C81418">
</head>
<body class="guide">
<nav id="topNav" aria-label="Secondary">
<div class="wrapper">
<strong class="more-info-label">Más en <a href="https://rubyonrails.org/">rubyonrails.org:</a> </strong>
<span class="red-button more-info-button">
Más Ruby on Rails
</span>
<ul class="more-info-links s-hidden">
<li class="more-info"><a href="https://rubyonrails.org/blog">Blog</a></li>
<li class="more-info"><a href="https://guides.rubyonrails.org/">Guías</a></li>
<li class="more-info"><a href="https://api.rubyonrails.org/">API</a></li>
<li class="more-info"><a href="https://discuss.rubyonrails.org/">Foro</a></li>
<li class="more-info"><a href="https://github.com/rails/rails">Contribuir en GitHub</a></li>
</ul>
</div>
</nav>
<header id="page_header">
<div class="wrapper clearfix">
<nav id="feature_nav">
<div class="header-logo">
<a href="index.html" title="Regresar a la página principal de Guías para Edge">Guías</a>
<span id="version_switcher">
Versión:
<select class="guides-version">
<option value="https://edgeguides.rubyonrails.org/" selected>Edge</option>
<option value="https://guides.rubyonrails.org/v7.2/">7.2</option>
<option value="https://guides.rubyonrails.org/v7.1/">7.1</option>
<option value="https://guides.rubyonrails.org/v7.0/">7.0</option>
<option value="https://guides.rubyonrails.org/v6.1/">6.1</option>
<option value="https://guides.rubyonrails.org/v6.0/">6.0</option>
<option value="https://guides.rubyonrails.org/v5.2/">5.2</option>
<option value="https://guides.rubyonrails.org/v5.1/">5.1</option>
<option value="https://guides.rubyonrails.org/v5.0/">5.0</option>
<option value="https://guides.rubyonrails.org/v4.2/">4.2</option>
<option value="https://guides.rubyonrails.org/v4.1/">4.1</option>
<option value="https://guides.rubyonrails.org/v4.0/">4.0</option>
<option value="https://guides.rubyonrails.org/v3.2/">3.2</option>
<option value="https://guides.rubyonrails.org/v3.1/">3.1</option>
<option value="https://guides.rubyonrails.org/v3.0/">3.0</option>
<option value="https://guides.rubyonrails.org/v2.3/">2.3</option>
</select>
</span>
</div>
<ul class="nav">
<li><a class="nav-item" id="home_nav" href="https://rubyonrails.org/">Inicio</a></li>
<li class="guides-index guides-index-large">
<a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Índice de Guías</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<dl class="guides-section-container">
<div class="guides-section">
<dt>Comienza Aquí</dt>
<dd><a href="getting_started.html">Primeros Pasos con Rails</a></dd>
</div>
<div class="guides-section">
<dt>Modelos</dt>
<dd><a href="active_record_basics.html">Conceptos Básicos de Active Record</a></dd>
<dd><a href="active_record_migrations.html">Migraciones de Active Record</a></dd>
<dd><a href="active_record_validations.html">Validaciones de Active Record</a></dd>
</div>
<div class="guides-section">
<dt>Vistas</dt>
<dd><a href="action_view_overview.html">Resumen de Action View</a></dd>
<dd><a href="layouts_and_rendering.html">Diseños y Renderizado en Rails</a></dd>
</div>
<div class="guides-section">
<dt>Controladores</dt>
<dd><a href="action_controller_overview.html">Resumen de Action Controller</a></dd>
<dd><a href="routing.html">Enrutamiento en Rails desde el Exterior</a></dd>
</div>
<div class="guides-section">
<dt>Otros Componentes</dt>
<dd><a href="active_support_core_extensions.html">Extensiones Básicas de Active Support</a></dd>
<dd><a href="action_mailer_basics.html">Conceptos Básicos de Action Mailer</a></dd>
<dd><a href="action_mailbox_basics.html">Conceptos Básicos de Action Mailbox</a></dd>
<dd><a href="action_text_overview.html">Resumen de Action Text</a></dd>
<dd><a href="active_job_basics.html">Conceptos Básicos de Active Job</a></dd>
</div>
<div class="guides-section">
<dt>Políticas</dt>
<dd><a href="maintenance_policy.html">Política de Mantenimiento</a></dd>
</div>
<div class="guides-section">
<dt>Notas de Lanzamiento</dt>
<dd><a href="upgrading_ruby_on_rails.html">Actualizando Ruby on Rails</a></dd>
<dd><a href="7_2_release_notes.html">Versión 7.2 - ?</a></dd>
<dd><a href="7_1_release_notes.html">Versión 7.1 - Octubre 2023</a></dd>
<dd><a href="7_0_release_notes.html">Versión 7.0 - Diciembre 2021</a></dd>
<dd><a href="6_1_release_notes.html">Versión 6.1 - Diciembre 2020</a></dd>
</div>
</dl>
</div>
</li>
<li><a class="nav-item" href="contributing_to_ruby_on_rails.html">Contribuir</a></li>
<li class="guides-index guides-index-small">
<select class="guides-index-item nav-item">
<option value="index.html">Índice de Guías</option>
<optgroup label="Comienza Aquí">
<option value="getting_started.html">Primeros Pasos con Rails</option>
</optgroup>
<optgroup label="Modelos">
<option value="active_record_basics.html">Conceptos Básicos de Active Record</option>
<option value="active_record_migrations.html">Migraciones de Active Record</option>
<option value="active_record_validations.html">Validaciones de Active Record</option>
</optgroup>
<optgroup label="Vistas">
<option value="action_view_overview.html">Resumen de Action View</option>
<option value="layouts_and_rendering.html">Diseños y Renderizado en Rails</option>
</optgroup>
<optgroup label="Controladores">
<option value="action_controller_overview.html">Resumen de Action Controller</option>
<option value="routing.html">Enrutamiento en Rails desde el Exterior</option>
</optgroup>
<optgroup label="Otros Componentes">
<option value="active_support_core_extensions.html">Extensiones Básicas de Active Support</option>
<option value="action_mailer_basics.html">Conceptos Básicos de Action Mailer</option>
<option value="action_mailbox_basics.html">Conceptos Básicos de Action Mailbox</option>
<option value="action_text_overview.html">Resumen de Action Text</option>
<option value="active_job_basics.html">Conceptos Básicos de Active Job</option>
</optgroup>
<optgroup label="Políticas">
<option value="maintenance_policy.html">Política de Mantenimiento</option>
</optgroup>
<optgroup label="Notas de Lanzamiento">
<option value="upgrading_ruby_on_rails.html">Actualizando Ruby on Rails</option>
<option value="7_2_release_notes.html">Versión 7.2 - ?</option>
<option value="7_1_release_notes.html">Versión 7.1 - Octubre 2023</option>
<option value="7_0_release_notes.html">Versión 7.0 - Diciembre 2021</option>
<option value="6_1_release_notes.html">Versión 6.1 - Diciembre 2020</option>
</optgroup>
</select>
</li>
</ul>
</nav>
</div>
</header>
<hr class="hide" />
<section id="feature">
<div class="wrapper">
<p><strong>NO LEA ESTE ARCHIVO EN GITHUB, LAS GUÍAS ESTÁN PUBLICADAS EN <a href="https://guides.rubyonrails.org">https://guides.rubyonrails.org</a>.</strong></p><h1>Conceptos Básicos de Action Mailer</h1><p>Esta guía te proporciona todo lo que necesitas para comenzar a enviar correos electrónicos desde tu aplicación y muchos aspectos internos de Action Mailer. También cubre cómo probar tus mailers.</p><p>Después de leer esta guía, sabrás:</p>
<ul>
<li>Cómo enviar correos electrónicos dentro de una aplicación Rails.</li>
<li>Cómo generar y editar una clase de Action Mailer y una vista de mailer.</li>
<li>Cómo configurar Action Mailer para tu entorno.</li>
<li>Cómo probar tus clases de Action Mailer.</li>
</ul>
<nav id="subCol">
<h3 class="chapter">
<picture>
<!-- Using the `source` HTML tag to set the dark theme image -->
<source
srcset="images/icon_book-close-bookmark-1-wht.svg"
media="(prefers-color-scheme: dark)"
/>
<img src="images/icon_book-close-bookmark-1.svg" alt="Chapter Icon" />
</picture>
Chapters
</h3>
<ol class="chapters">
<li><a href="#¿qué-es-action-mailer-questionmark">¿Qué es Action Mailer?</a>
<ul>
<li><a href="#los-mailers-son-similares-a-los-controladores">Los Mailers son Similares a los Controladores</a></li>
</ul></li>
<li><a href="#enviando-correos-electrónicos">Enviando Correos Electrónicos</a>
<ul>
<li><a href="#guía-para-generar-un-mailer">Guía para Generar un Mailer</a></li>
<li><a href="#codificación-automática-de-valores-de-encabezado">Codificación Automática de Valores de Encabezado</a></li>
<li><a href="#lista-completa-de-métodos-de-action-mailer">Lista Completa de Métodos de Action Mailer</a></li>
<li><a href="#vistas-de-mailer">Vistas de Mailer</a></li>
<li><a href="#layouts-de-action-mailer">Layouts de Action Mailer</a></li>
<li><a href="#previsualización-de-correos-electrónicos">Previsualización de Correos Electrónicos</a></li>
<li><a href="#generación-de-urls-en-vistas-de-action-mailer">Generación de URLs en Vistas de Action Mailer</a></li>
<li><a href="#agregar-imágenes-en-vistas-de-action-mailer">Agregar Imágenes en Vistas de Action Mailer</a></li>
<li><a href="#envío-de-correos-electrónicos-multipart">Envío de Correos Electrónicos Multipart</a></li>
<li><a href="#envío-de-correos-electrónicos-con-opciones-de-entrega-dinámicas">Envío de Correos Electrónicos con Opciones de Entrega Dinámicas</a></li>
<li><a href="#envío-de-correos-electrónicos-sin-renderizado-de-plantilla">Envío de Correos Electrónicos sin Renderizado de Plantilla</a></li>
</ul></li>
<li><a href="#callbacks-de-action-mailer">Callbacks de Action Mailer</a></li>
<li><a href="#uso-de-helpers-de-action-mailer">Uso de Helpers de Action Mailer</a></li>
<li><a href="#configuración-de-action-mailer">Configuración de Action Mailer</a>
<ul>
<li><a href="#ejemplo-de-configuración-de-action-mailer">Ejemplo de Configuración de Action Mailer</a></li>
<li><a href="#configuración-de-action-mailer-para-gmail">Configuración de Action Mailer para Gmail</a></li>
</ul></li>
<li><a href="#pruebas-de-mailer">Pruebas de Mailer</a></li>
<li><a href="#interceptando-y-observando-correos-electrónicos">Interceptando y Observando Correos Electrónicos</a>
<ul>
<li><a href="#interceptando-correos-electrónicos">Interceptando Correos Electrónicos</a></li>
<li><a href="#observando-correos-electrónicos">Observando Correos Electrónicos</a></li>
</ul></li>
</ol>
</nav>
<hr>
</div>
</section>
<main id="container">
<div class="wrapper">
<div id="mainCol">
<h2 id="¿qué-es-action-mailer-questionmark"><a class="anchorlink" href="#¿qué-es-action-mailer-questionmark"><span>1</span> ¿Qué es Action Mailer?</a></h2><p>Action Mailer te permite enviar correos electrónicos desde tu aplicación utilizando clases de mailer y vistas.</p><h3 id="los-mailers-son-similares-a-los-controladores"><a class="anchorlink" href="#los-mailers-son-similares-a-los-controladores"><span>1.1</span> Los Mailers son Similares a los Controladores</a></h3><p>Heredan de <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html"><code>ActionMailer::Base</code></a> y residen en <code>app/mailers</code>. Los mailers también funcionan muy similar a los controladores. Algunos ejemplos de similitudes se enumeran a continuación. Los mailers tienen:</p>
<ul>
<li>Acciones, y también, vistas asociadas que aparecen en <code>app/views</code>.</li>
<li>Variables de instancia que son accesibles en las vistas.</li>
<li>La capacidad de utilizar layouts y parciales.</li>
<li>La capacidad de acceder a un hash de params.</li>
</ul>
<h2 id="enviando-correos-electrónicos"><a class="anchorlink" href="#enviando-correos-electrónicos"><span>2</span> Enviando Correos Electrónicos</a></h2><p>Esta sección proporcionará una guía paso a paso para crear un mailer y sus vistas.</p><h3 id="guía-para-generar-un-mailer"><a class="anchorlink" href="#guía-para-generar-un-mailer"><span>2.1</span> Guía para Generar un Mailer</a></h3><h4 id="crear-el-mailer"><a class="anchorlink" href="#crear-el-mailer"><span>2.1.1</span> Crear el Mailer</a></h4><div class="interstitial code">
<pre><code class="highlight console"><span class="gp">$</span><span class="w"> </span><span class="nb">bin/rails </span>generate mailer User
<span class="go">create app/mailers/user_mailer.rb
create app/mailers/application_mailer.rb
invoke erb
create app/views/user_mailer
create app/views/layouts/mailer.text.erb
create app/views/layouts/mailer.html.erb
invoke test_unit
create test/mailers/user_mailer_test.rb
create test/mailers/previews/user_mailer_preview.rb
</span></code></pre>
<button class="clipboard-button" data-clipboard-text="bin/rails generate mailer User
">Copy</button>
</div>
<div class="interstitial code">
<pre><code class="highlight ruby"><span class="c1"># app/mailers/application_mailer.rb</span>
<span class="k">class</span> <span class="nc">ApplicationMailer</span> <span class="o"><</span> <span class="no">ActionMailer</span><span class="o">::</span><span class="no">Base</span>
<span class="n">default</span> <span class="ss">from: </span><span class="s2">"[email protected]"</span>
<span class="n">layout</span> <span class="s1">'mailer'</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class ApplicationMailer < ActionMailer::Base
default from: "[email protected]"
layout 'mailer'
end
">Copy</button>
</div>
<div class="interstitial code">
<pre><code class="highlight ruby"><span class="c1"># app/mailers/user_mailer.rb</span>
<span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
end
">Copy</button>
</div>
<p>Como puedes ver, puedes generar mailers al igual que usas otros generadores con Rails.</p><p>Si no quisieras usar un generador, podrías crear tu propio archivo dentro de <code>app/mailers</code>, solo asegúrate de que hereda de <code>ActionMailer::Base</code>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">MyMailer</span> <span class="o"><</span> <span class="no">ActionMailer</span><span class="o">::</span><span class="no">Base</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class MyMailer < ActionMailer::Base
end
">Copy</button>
</div>
<h4 id="editar-el-mailer"><a class="anchorlink" href="#editar-el-mailer"><span>2.1.2</span> Editar el Mailer</a></h4><p>Los mailers tienen métodos llamados "acciones" y usan vistas para estructurar su contenido. Donde un controlador genera contenido como HTML para enviar de vuelta al cliente, un Mailer crea un mensaje para ser entregado por correo electrónico.</p><p><code>app/mailers/user_mailer.rb</code> contiene un mailer vacío:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
end
">Copy</button>
</div>
<p>Vamos a añadir un método llamado <code>welcome_email</code>, que enviará un correo electrónico a la dirección de correo registrada del usuario:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">default</span> <span class="ss">from: </span><span class="s1">'[email protected]'</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span>
<span class="vi">@url</span> <span class="o">=</span> <span class="s1">'http://example.com/login'</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="p">,</span> <span class="ss">subject: </span><span class="s1">'Welcome to My Awesome Site'</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
default from: '[email protected]'
def welcome_email
@user = params[:user]
@url = 'http://example.com/login'
mail(to: @user.email, subject: 'Welcome to My Awesome Site')
end
end
">Copy</button>
</div>
<p>Aquí tienes una explicación rápida de los elementos presentados en el método anterior. Para una lista completa de todas las opciones disponibles, por favor consulta más abajo en la sección Lista Completa de Atributos Configurables de Action Mailer.</p>
<ul>
<li>El método <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-c-default"><code>default</code></a> establece valores predeterminados para todos los correos electrónicos enviados desde este mailer. En este caso, lo usamos para establecer el valor del encabezado <code>:from</code> para todos los mensajes en esta clase. Esto se puede anular por correo electrónico.</li>
<li>El método <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-i-mail"><code>mail</code></a> crea el mensaje de correo electrónico real. Lo usamos para especificar los valores de los encabezados como <code>:to</code> y <code>:subject</code> por correo electrónico.</li>
</ul>
<h4 id="crear-una-vista-de-mailer"><a class="anchorlink" href="#crear-una-vista-de-mailer"><span>2.1.3</span> Crear una Vista de Mailer</a></h4><p>Crea un archivo llamado <code>welcome_email.html.erb</code> en <code>app/views/user_mailer/</code>. Esta será la plantilla utilizada para el correo electrónico, formateada en HTML:</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><!DOCTYPE html></span>
<span class="nt"><html></span>
<span class="nt"><head></span>
<span class="nt"><meta</span> <span class="na">content=</span><span class="s">'text/html; charset=UTF-8'</span> <span class="na">http-equiv=</span><span class="s">'Content-Type'</span> <span class="nt">/></span>
<span class="nt"></head></span>
<span class="nt"><body></span>
<span class="nt"><h1></span>Welcome to example.com, <span class="cp"><%=</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">name</span> <span class="cp">%></span><span class="nt"></h1></span>
<span class="nt"><p></span>
You have successfully signed up to example.com,
your username is: <span class="cp"><%=</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">login</span> <span class="cp">%></span>.<span class="nt"><br></span>
<span class="nt"></p></span>
<span class="nt"><p></span>
To login to the site, just follow this link: <span class="cp"><%=</span> <span class="vi">@url</span> <span class="cp">%></span>.
<span class="nt"></p></span>
<span class="nt"><p></span>Thanks for joining and have a great day!<span class="nt"></p></span>
<span class="nt"></body></span>
<span class="nt"></html></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<!DOCTYPE html>
<html>
<head>
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
</head>
<body>
<h1>Welcome to example.com, <%= @user.name %></h1>
<p>
You have successfully signed up to example.com,
your username is: <%= @user.login %>.<br>
</p>
<p>
To login to the site, just follow this link: <%= @url %>.
</p>
<p>Thanks for joining and have a great day!</p>
</body>
</html>
">Copy</button>
</div>
<p>También hagamos una parte de texto para este correo electrónico. No todos los clientes prefieren correos electrónicos HTML, por lo que enviar ambos es una buena práctica. Para hacer esto, crea un archivo llamado <code>welcome_email.text.erb</code> en <code>app/views/user_mailer/</code>:</p><div class="interstitial code">
<pre><code class="highlight erb">Welcome to example.com, <span class="cp"><%=</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">name</span> <span class="cp">%></span>
===============================================
You have successfully signed up to example.com,
your username is: <span class="cp"><%=</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">login</span> <span class="cp">%></span>.
To login to the site, just follow this link: <span class="cp"><%=</span> <span class="vi">@url</span> <span class="cp">%></span>.
Thanks for joining and have a great day!
</code></pre>
<button class="clipboard-button" data-clipboard-text="Welcome to example.com, <%= @user.name %>
===============================================
You have successfully signed up to example.com,
your username is: <%= @user.login %>.
To login to the site, just follow this link: <%= @url %>.
Thanks for joining and have a great day!
">Copy</button>
</div>
<p>Cuando ahora llames al método <code>mail</code>, Action Mailer detectará las dos plantillas (texto y HTML) y automáticamente generará un correo electrónico <code>multipart/alternative</code>.</p><h4 id="llamando-al-mailer"><a class="anchorlink" href="#llamando-al-mailer"><span>2.1.4</span> Llamando al Mailer</a></h4><p>Los mailers son realmente solo otra forma de renderizar una vista. En lugar de renderizar una vista y enviarla a través del protocolo HTTP, la están enviando a través de los protocolos de correo electrónico. Debido a esto, tiene sentido que tu controlador le diga al Mailer que envíe un correo electrónico cuando un usuario se crea exitosamente.</p><p>Configurar esto es simple.</p><p>Primero, vamos a crear un scaffold de <code>User</code>:</p><div class="interstitial code">
<pre><code class="highlight console"><span class="gp">$</span><span class="w"> </span><span class="nb">bin/rails </span>generate scaffold user name email login
<span class="gp">$</span><span class="w"> </span><span class="nb">bin/rails </span>db:migrate
</code></pre>
<button class="clipboard-button" data-clipboard-text="bin/rails generate scaffold user name email login
bin/rails db:migrate
">Copy</button>
</div>
<p>Ahora que tenemos un modelo de usuario para jugar, editaremos el archivo <code>app/controllers/users_controller.rb</code>, haremos que instruya al <code>UserMailer</code> para entregar un correo electrónico al usuario recién creado editando la acción create e insertando una llamada a <code>UserMailer.with(user: @user).welcome_email</code> justo después de que el usuario se guarde exitosamente.</p><p>Colocaremos el correo electrónico en cola para ser enviado usando <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html#method-i-deliver_later"><code>deliver_later</code></a>, que está respaldado por Active Job. De esa manera, la acción del controlador puede continuar sin esperar a que se complete el envío.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UsersController</span> <span class="o"><</span> <span class="no">ApplicationController</span>
<span class="c1"># ...</span>
<span class="c1"># POST /users or /users.json</span>
<span class="k">def</span> <span class="nf">create</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="no">User</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">user_params</span><span class="p">)</span>
<span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
<span class="k">if</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">save</span>
<span class="c1"># Tell the UserMailer to send a welcome email after save</span>
<span class="no">UserMailer</span><span class="p">.</span><span class="nf">with</span><span class="p">(</span><span class="ss">user: </span><span class="vi">@user</span><span class="p">).</span><span class="nf">welcome_email</span><span class="p">.</span><span class="nf">deliver_later</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">html</span> <span class="p">{</span> <span class="n">redirect_to</span><span class="p">(</span><span class="vi">@user</span><span class="p">,</span> <span class="ss">notice: </span><span class="s1">'User was successfully created.'</span><span class="p">)</span> <span class="p">}</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">json</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">json: </span><span class="vi">@user</span><span class="p">,</span> <span class="ss">status: :created</span><span class="p">,</span> <span class="ss">location: </span><span class="vi">@user</span> <span class="p">}</span>
<span class="k">else</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">html</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">action: </span><span class="s1">'new'</span> <span class="p">}</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">json</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">json: </span><span class="vi">@user</span><span class="p">.</span><span class="nf">errors</span><span class="p">,</span> <span class="ss">status: :unprocessable_entity</span> <span class="p">}</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="c1"># ...</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UsersController < ApplicationController
# ...
# POST /users or /users.json
def create
@user = User.new(user_params)
respond_to do |format|
if @user.save
# Tell the UserMailer to send a welcome email after save
UserMailer.with(user: @user).welcome_email.deliver_later
format.html { redirect_to(@user, notice: 'User was successfully created.') }
format.json { render json: @user, status: :created, location: @user }
else
format.html { render action: 'new' }
format.json { render json: @user.errors, status: :unprocessable_entity }
end
end
end
# ...
end
">Copy</button>
</div>
<p>NOTA: El comportamiento predeterminado de Active Job es ejecutar trabajos a través del adaptador <code>:async</code>. Por lo tanto, puedes usar <code>deliver_later</code> para enviar correos electrónicos de forma asíncrona. El adaptador predeterminado de Active Job ejecuta trabajos con un pool de hilos en proceso. Es adecuado para los entornos de desarrollo/prueba, ya que no requiere ninguna infraestructura externa, pero es una mala opción para producción, ya que elimina los trabajos pendientes al reiniciar. Si necesitas un backend persistente, necesitarás usar un adaptador de Active Job que tenga un backend persistente (Sidekiq, Resque, etc.).</p><p>Si deseas enviar correos electrónicos de inmediato (por ejemplo, desde un cronjob) simplemente llama a <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html#method-i-deliver_now"><code>deliver_now</code></a>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">SendWeeklySummary</span>
<span class="k">def</span> <span class="nf">run</span>
<span class="no">User</span><span class="p">.</span><span class="nf">find_each</span> <span class="k">do</span> <span class="o">|</span><span class="n">user</span><span class="o">|</span>
<span class="no">UserMailer</span><span class="p">.</span><span class="nf">with</span><span class="p">(</span><span class="ss">user: </span><span class="n">user</span><span class="p">).</span><span class="nf">weekly_summary</span><span class="p">.</span><span class="nf">deliver_now</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class SendWeeklySummary
def run
User.find_each do |user|
UserMailer.with(user: user).weekly_summary.deliver_now
end
end
end
">Copy</button>
</div>
<p>Cualquier par clave-valor pasado a <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Parameterized/ClassMethods.html#method-i-with"><code>with</code></a> simplemente se convierte en los <code>params</code> para la acción del mailer. Así que <code>with(user: @user, account: @user.account)</code> hace que <code>params[:user]</code> y <code>params[:account]</code> estén disponibles en la acción del mailer. Al igual que los controladores tienen params.</p><p>El método <code>weekly_summary</code> devuelve un objeto <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html"><code>ActionMailer::MessageDelivery</code></a> que luego puede ser instruido para <code>deliver_now</code> o <code>deliver_later</code> para enviarse a sí mismo. El objeto <code>ActionMailer::MessageDelivery</code> es un envoltorio alrededor de un <a href="https://edgeapi.rubyonrails.org/classes/Mail/Message.html"><code>Mail::Message</code></a>. Si deseas inspeccionar, alterar o hacer cualquier otra cosa con el objeto <code>Mail::Message</code>, puedes acceder a él con el método <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html#method-i-message"><code>message</code></a> en el objeto <code>ActionMailer::MessageDelivery</code>.</p><h3 id="codificación-automática-de-valores-de-encabezado"><a class="anchorlink" href="#codificación-automática-de-valores-de-encabezado"><span>2.2</span> Codificación Automática de Valores de Encabezado</a></h3><p>Action Mailer maneja la codificación automática de caracteres multibyte dentro de los encabezados y cuerpos.</p><p>Para ejemplos más complejos, como definir conjuntos de caracteres alternativos o auto-codificar texto primero, por favor consulta la biblioteca <a href="https://github.com/mikel/mail">Mail</a>.</p><h3 id="lista-completa-de-métodos-de-action-mailer"><a class="anchorlink" href="#lista-completa-de-métodos-de-action-mailer"><span>2.3</span> Lista Completa de Métodos de Action Mailer</a></h3><p>Solo hay tres métodos que necesitas para enviar prácticamente cualquier mensaje de correo electrónico:</p>
<ul>
<li><a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-i-headers"><code>headers</code></a> - Especifica cualquier encabezado en el correo electrónico que desees. Puedes pasar un hash de nombres de campos de encabezado y pares de valores, o puedes llamar a <code>headers[:field_name] = 'value'</code>.</li>
<li><a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-i-attachments"><code>attachments</code></a> - Te permite agregar archivos adjuntos a tu correo electrónico. Por ejemplo, <code>attachments['file-name.jpg'] = File.read('file-name.jpg')</code>.</li>
<li><a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-i-mail"><code>mail</code></a> - Crea el correo electrónico en sí. Puedes pasar encabezados como un hash al método <code>mail</code> como un parámetro. <code>mail</code> creará un correo electrónico, ya sea de texto plano o multipart, dependiendo de las plantillas de correo electrónico que hayas definido.</li>
</ul>
<h4 id="agregar-archivos-adjuntos"><a class="anchorlink" href="#agregar-archivos-adjuntos"><span>2.3.1</span> Agregar Archivos Adjuntos</a></h4><p>Action Mailer hace que sea muy fácil agregar archivos adjuntos.</p>
<ul>
<li><p>Pasa el nombre del archivo y el contenido, y Action Mailer y la gema <a href="https://github.com/mikel/mail">Mail</a> adivinarán automáticamente el <code>mime_type</code>, establecerán la <code>codificación</code> y crearán el archivo adjunto.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">attachments</span><span class="p">[</span><span class="s1">'filename.jpg'</span><span class="p">]</span> <span class="o">=</span> <span class="no">File</span><span class="p">.</span><span class="nf">read</span><span class="p">(</span><span class="s1">'/path/to/filename.jpg'</span><span class="p">)</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
">Copy</button>
</div></li>
</ul>
<p> Cuando se active el método <code>mail</code>, enviará un correo electrónico multipart con un archivo adjunto, adecuadamente anidado con el nivel superior siendo <code>multipart/mixed</code> y la primera parte siendo un <code>multipart/alternative</code> que contiene los mensajes de correo electrónico en texto plano y HTML.</p><p>NOTA: Mail codificará automáticamente un archivo adjunto en Base64. Si deseas algo diferente, codifica tu contenido y pásalo codificado junto con la codificación en un <code>Hash</code> al método <code>attachments</code>.</p>
<ul>
<li><p>Pasa el nombre del archivo y especifica encabezados y contenido, y Action Mailer y Mail usarán la configuración que pases.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">encoded_content</span> <span class="o">=</span> <span class="no">SpecialEncode</span><span class="p">(</span><span class="no">File</span><span class="p">.</span><span class="nf">read</span><span class="p">(</span><span class="s1">'/path/to/filename.jpg'</span><span class="p">))</span>
<span class="n">attachments</span><span class="p">[</span><span class="s1">'filename.jpg'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="ss">mime_type: </span><span class="s1">'application/gzip'</span><span class="p">,</span>
<span class="ss">encoding: </span><span class="s1">'SpecialEncoding'</span><span class="p">,</span>
<span class="ss">content: </span><span class="n">encoded_content</span>
<span class="p">}</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="encoded_content = SpecialEncode(File.read('/path/to/filename.jpg'))
attachments['filename.jpg'] = {
mime_type: 'application/gzip',
encoding: 'SpecialEncoding',
content: encoded_content
}
">Copy</button>
</div></li>
</ul>
<p>NOTA: Si especificas una codificación, Mail asumirá que tu contenido ya está codificado y no intentará codificarlo en Base64.</p><h4 id="hacer-archivos-adjuntos-inline"><a class="anchorlink" href="#hacer-archivos-adjuntos-inline"><span>2.3.2</span> Hacer Archivos Adjuntos Inline</a></h4><p>Action Mailer 3.0 hace que los archivos adjuntos inline, que involucraban mucho hacking en versiones anteriores a 3.0, sean mucho más simples y triviales como deberían ser.</p>
<ul>
<li><p>Primero, para decirle a Mail que convierta un archivo adjunto en un archivo adjunto inline, solo llama a <code>#inline</code> en el método attachments dentro de tu Mailer:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">def</span> <span class="nf">welcome</span>
<span class="n">attachments</span><span class="p">.</span><span class="nf">inline</span><span class="p">[</span><span class="s1">'image.jpg'</span><span class="p">]</span> <span class="o">=</span> <span class="no">File</span><span class="p">.</span><span class="nf">read</span><span class="p">(</span><span class="s1">'/path/to/image.jpg'</span><span class="p">)</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="def welcome
attachments.inline['image.jpg'] = File.read('/path/to/image.jpg')
end
">Copy</button>
</div></li>
<li><p>Luego, en tu vista, puedes simplemente referenciar <code>attachments</code> como un hash y especificar qué archivo adjunto deseas mostrar, llamando a <code>url</code> sobre él y luego pasando el resultado al método <code>image_tag</code>:</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="nt"><p></span>Hello there, this is our image<span class="nt"></p></span>
<span class="cp"><%=</span> <span class="n">image_tag</span> <span class="n">attachments</span><span class="p">[</span><span class="s1">'image.jpg'</span><span class="p">].</span><span class="nf">url</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<p>Hello there, this is our image</p>
<%= image_tag attachments['image.jpg'].url %>
">Copy</button>
</div></li>
<li><p>Como esta es una llamada estándar a <code>image_tag</code>, puedes pasar un hash de opciones después de la URL del archivo adjunto como podrías para cualquier otra imagen:</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="nt"><p></span>Hello there, this is our image<span class="nt"></p></span>
<span class="cp"><%=</span> <span class="n">image_tag</span> <span class="n">attachments</span><span class="p">[</span><span class="s1">'image.jpg'</span><span class="p">].</span><span class="nf">url</span><span class="p">,</span> <span class="ss">alt: </span><span class="s1">'My Photo'</span><span class="p">,</span> <span class="ss">class: </span><span class="s1">'photos'</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<p>Hello there, this is our image</p>
<%= image_tag attachments['image.jpg'].url, alt: 'My Photo', class: 'photos' %>
">Copy</button>
</div></li>
</ul>
<h4 id="enviar-correo-electrónico-a-múltiples-destinatarios"><a class="anchorlink" href="#enviar-correo-electrónico-a-múltiples-destinatarios"><span>2.3.3</span> Enviar Correo Electrónico a Múltiples Destinatarios</a></h4><p>Es posible enviar correo electrónico a uno o más destinatarios en un solo correo electrónico (por ejemplo, informando a todos los administradores de un nuevo registro) configurando la lista de correos electrónicos en la clave <code>:to</code>. La lista de correos electrónicos puede ser un array de direcciones de correo electrónico o una sola cadena con las direcciones separadas por comas.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">AdminMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">default</span> <span class="ss">to: </span><span class="o">-></span> <span class="p">{</span> <span class="no">Admin</span><span class="p">.</span><span class="nf">pluck</span><span class="p">(</span><span class="ss">:email</span><span class="p">)</span> <span class="p">},</span>
<span class="ss">from: </span><span class="s1">'[email protected]'</span>
<span class="k">def</span> <span class="nf">new_registration</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">user</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">subject: </span><span class="s2">"New User Signup: </span><span class="si">#{</span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class AdminMailer < ApplicationMailer
default to: -> { Admin.pluck(:email) },
from: '[email protected]'
def new_registration(user)
@user = user
mail(subject: "New User Signup: #{@user.email}")
end
end
">Copy</button>
</div>
<p>El mismo formato se puede usar para establecer destinatarios de copia de carbón (Cc:) y copia de carbón oculta (Bcc:), usando las claves <code>:cc</code> y <code>:bcc</code> respectivamente.</p><h4 id="enviar-correo-electrónico-con-nombre"><a class="anchorlink" href="#enviar-correo-electrónico-con-nombre"><span>2.3.4</span> Enviar Correo Electrónico con Nombre</a></h4><p>A veces deseas mostrar el nombre de la persona en lugar de solo su dirección de correo electrónico cuando reciben el correo electrónico. Puedes usar <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-i-email_address_with_name"><code>email_address_with_name</code></a> para eso:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">def</span> <span class="nf">welcome_email</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span>
<span class="n">mail</span><span class="p">(</span>
<span class="ss">to: </span><span class="n">email_address_with_name</span><span class="p">(</span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="p">,</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">name</span><span class="p">),</span>
<span class="ss">subject: </span><span class="s1">'Welcome to My Awesome Site'</span>
<span class="p">)</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="def welcome_email
@user = params[:user]
mail(
to: email_address_with_name(@user.email, @user.name),
subject: 'Welcome to My Awesome Site'
)
end
">Copy</button>
</div>
<p>La misma técnica funciona para especificar un nombre de remitente:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">default</span> <span class="ss">from: </span><span class="n">email_address_with_name</span><span class="p">(</span><span class="s1">'[email protected]'</span><span class="p">,</span> <span class="s1">'Example Company Notifications'</span><span class="p">)</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
default from: email_address_with_name('[email protected]', 'Example Company Notifications')
end
">Copy</button>
</div>
<p>Si el nombre es una cadena vacía, devuelve solo la dirección.</p><h3 id="vistas-de-mailer"><a class="anchorlink" href="#vistas-de-mailer"><span>2.4</span> Vistas de Mailer</a></h3><p>Las vistas de Mailer están ubicadas en el directorio <code>app/views/name_of_mailer_class</code>. La vista específica del mailer es conocida por la clase porque su nombre es el mismo que el método del mailer. En nuestro ejemplo anterior, nuestra vista de mailer para el método <code>welcome_email</code> estará en <code>app/views/user_mailer/welcome_email.html.erb</code> para la versión HTML y <code>welcome_email.text.erb</code> para la versión en texto plano.</p><p>Para cambiar la vista predeterminada del mailer para tu acción, haz algo como esto:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">default</span> <span class="ss">from: </span><span class="s1">'[email protected]'</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span>
<span class="vi">@url</span> <span class="o">=</span> <span class="s1">'http://example.com/login'</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="p">,</span>
<span class="ss">subject: </span><span class="s1">'Welcome to My Awesome Site'</span><span class="p">,</span>
<span class="ss">template_path: </span><span class="s1">'notifications'</span><span class="p">,</span>
<span class="ss">template_name: </span><span class="s1">'another'</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
default from: '[email protected]'
def welcome_email
@user = params[:user]
@url = 'http://example.com/login'
mail(to: @user.email,
subject: 'Welcome to My Awesome Site',
template_path: 'notifications',
template_name: 'another')
end
end
">Copy</button>
</div>
<p>En este caso, buscará plantillas en <code>app/views/notifications</code> con el nombre <code>another</code>. También puedes especificar un array de rutas para <code>template_path</code>, y se buscarán en orden.</p><p>Si deseas más flexibilidad, también puedes pasar un bloque y renderizar plantillas específicas o incluso renderizar inline o texto sin usar un archivo de plantilla:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">default</span> <span class="ss">from: </span><span class="s1">'[email protected]'</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span>
<span class="vi">@url</span> <span class="o">=</span> <span class="s1">'http://example.com/login'</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="p">,</span>
<span class="ss">subject: </span><span class="s1">'Welcome to My Awesome Site'</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">html</span> <span class="p">{</span> <span class="n">render</span> <span class="s1">'another_template'</span> <span class="p">}</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">text</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">plain: </span><span class="s1">'Render text'</span> <span class="p">}</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
default from: '[email protected]'
def welcome_email
@user = params[:user]
@url = 'http://example.com/login'
mail(to: @user.email,
subject: 'Welcome to My Awesome Site') do |format|
format.html { render 'another_template' }
format.text { render plain: 'Render text' }
end
end
end
">Copy</button>
</div>
<p>Esto renderizará la plantilla 'another_template.html.erb' para la parte HTML y usará el texto renderizado para la parte de texto. El comando render es el mismo que se usa dentro de Action Controller, por lo que puedes usar todas las mismas opciones, como <code>:text</code>, <code>:inline</code>, etc.</p><p>Si te gustaría renderizar una plantilla ubicada fuera del directorio predeterminado <code>app/views/mailer_name/</code>, puedes aplicar <a href="https://edgeapi.rubyonrails.org/classes/ActionView/ViewPaths/ClassMethods.html#method-i-prepend_view_path"><code>prepend_view_path</code></a>, así:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">prepend_view_path</span> <span class="s2">"custom/path/to/mailer/view"</span>
<span class="c1"># This will try to load "custom/path/to/mailer/view/welcome_email" template</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="c1"># ...</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
prepend_view_path "custom/path/to/mailer/view"
# This will try to load "custom/path/to/mailer/view/welcome_email" template
def welcome_email
# ...
end
end
">Copy</button>
</div>
<p>También puedes considerar usar el método <a href="https://edgeapi.rubyonrails.org/classes/ActionView/ViewPaths/ClassMethods.html#method-i-append_view_path"><code>append_view_path</code></a>.</p><h4 id="caché-de-vistas-de-mailer"><a class="anchorlink" href="#caché-de-vistas-de-mailer"><span>2.4.1</span> Caché de Vistas de Mailer</a></h4><p>Puedes realizar caché de fragmentos en vistas de mailer como en vistas de aplicación usando el método <a href="https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache"><code>cache</code></a>.</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%</span> <span class="n">cache</span> <span class="k">do</span> <span class="cp">%></span>
<span class="cp"><%=</span> <span class="vi">@company</span><span class="p">.</span><span class="nf">name</span> <span class="cp">%></span>
<span class="cp"><%</span> <span class="k">end</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<% cache do %>
<%= @company.name %>
<% end %>
">Copy</button>
</div>
<p>Y para usar esta función, necesitas configurar tu aplicación con esto:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">config</span><span class="p">.</span><span class="nf">action_mailer</span><span class="p">.</span><span class="nf">perform_caching</span> <span class="o">=</span> <span class="kp">true</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="config.action_mailer.perform_caching = true
">Copy</button>
</div>
<p>El caché de fragmentos también es compatible en correos electrónicos multipart. Lee más sobre caché en la <a href="caching_with_rails.html">guía de caché de Rails</a>.</p><h3 id="layouts-de-action-mailer"><a class="anchorlink" href="#layouts-de-action-mailer"><span>2.5</span> Layouts de Action Mailer</a></h3><p>Al igual que las vistas de controlador, también puedes tener layouts de mailer. El nombre del layout necesita ser el mismo que tu mailer, como <code>user_mailer.html.erb</code> y <code>user_mailer.text.erb</code> para ser reconocido automáticamente por tu mailer como un layout.</p><p>Para usar un archivo diferente, llama a <a href="https://edgeapi.rubyonrails.org/classes/ActionView/Layouts/ClassMethods.html#method-i-layout"><code>layout</code></a> en tu mailer:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">layout</span> <span class="s1">'awesome'</span> <span class="c1"># use awesome.(html|text).erb as the layout</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
layout 'awesome' # use awesome.(html|text).erb as the layout
end
">Copy</button>
</div>
<p>Al igual que con las vistas de controlador, usa <code>yield</code> para renderizar la vista dentro del layout.</p><p>También puedes pasar una opción <code>layout: 'layout_name'</code> a la llamada render dentro del bloque de formato para especificar diferentes layouts para diferentes formatos:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">].</span><span class="nf">email</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">html</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">layout: </span><span class="s1">'my_layout'</span> <span class="p">}</span>
<span class="nb">format</span><span class="p">.</span><span class="nf">text</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
def welcome_email
mail(to: params[:user].email) do |format|
format.html { render layout: 'my_layout' }
format.text
end
end
end
">Copy</button>
</div>
<p>Renderizará la parte HTML usando el archivo <code>my_layout.html.erb</code> y la parte de texto con el archivo usual <code>user_mailer.text.erb</code> si existe.</p><h3 id="previsualización-de-correos-electrónicos"><a class="anchorlink" href="#previsualización-de-correos-electrónicos"><span>2.6</span> Previsualización de Correos Electrónicos</a></h3><p>Las previsualizaciones de Action Mailer proporcionan una forma de ver cómo se ven los correos electrónicos visitando una URL especial que los renderiza. En el ejemplo anterior, la clase de previsualización para <code>UserMailer</code> debería llamarse <code>UserMailerPreview</code> y ubicarse en <code>test/mailers/previews/user_mailer_preview.rb</code>. Para ver la previsualización de <code>welcome_email</code>, implementa un método que tenga el mismo nombre y llama a <code>UserMailer.welcome_email</code>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailerPreview</span> <span class="o"><</span> <span class="no">ActionMailer</span><span class="o">::</span><span class="no">Preview</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="no">UserMailer</span><span class="p">.</span><span class="nf">with</span><span class="p">(</span><span class="ss">user: </span><span class="no">User</span><span class="p">.</span><span class="nf">first</span><span class="p">).</span><span class="nf">welcome_email</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailerPreview < ActionMailer::Preview
def welcome_email
UserMailer.with(user: User.first).welcome_email
end
end
">Copy</button>
</div>
<p>Luego, la previsualización estará disponible en <a href="http://localhost:3000/rails/mailers/user_mailer/welcome_email">http://localhost:3000/rails/mailers/user_mailer/welcome_email</a>.</p><p>Si cambias algo en <code>app/views/user_mailer/welcome_email.html.erb</code> o en el propio mailer, se recargará automáticamente y lo renderizará para que puedas ver visualmente el nuevo estilo al instante. Una lista de previsualizaciones también está disponible en <a href="http://localhost:3000/rails/mailers">http://localhost:3000/rails/mailers</a>.</p><p>Por defecto, estas clases de previsualización viven en <code>test/mailers/previews</code>. Esto se puede configurar usando la opción <code>preview_paths</code>. Por ejemplo, si deseas agregar <code>lib/mailer_previews</code> a esto, puedes configurarlo en <code>config/application.rb</code>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">config</span><span class="p">.</span><span class="nf">action_mailer</span><span class="p">.</span><span class="nf">preview_paths</span> <span class="o"><<</span> <span class="s2">"</span><span class="si">#{</span><span class="no">Rails</span><span class="p">.</span><span class="nf">root</span><span class="si">}</span><span class="s2">/lib/mailer_previews"</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="config.action_mailer.preview_paths << "#{Rails.root}/lib/mailer_previews"
">Copy</button>
</div>
<h3 id="generación-de-urls-en-vistas-de-action-mailer"><a class="anchorlink" href="#generación-de-urls-en-vistas-de-action-mailer"><span>2.7</span> Generación de URLs en Vistas de Action Mailer</a></h3><p>A diferencia de los controladores, la instancia del mailer no tiene ningún contexto sobre la solicitud entrante, por lo que necesitarás proporcionar el parámetro <code>:host</code> tú mismo.</p><p>Como el <code>:host</code> generalmente es consistente en toda la aplicación, puedes configurarlo globalmente en <code>config/application.rb</code>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">config</span><span class="p">.</span><span class="nf">action_mailer</span><span class="p">.</span><span class="nf">default_url_options</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">host: </span><span class="s1">'example.com'</span> <span class="p">}</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="config.action_mailer.default_url_options = { host: 'example.com' }
">Copy</button>
</div>
<p>Debido a este comportamiento, no puedes usar ninguno de los helpers <code>*_path</code> dentro de un correo electrónico. En su lugar, necesitarás usar el helper asociado <code>*_url</code>. Por ejemplo, en lugar de usar</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%=</span> <span class="n">link_to</span> <span class="s1">'welcome'</span><span class="p">,</span> <span class="n">welcome_path</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<%= link_to 'welcome', welcome_path %>
">Copy</button>
</div>
<p>Necesitarás usar:</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%=</span> <span class="n">link_to</span> <span class="s1">'welcome'</span><span class="p">,</span> <span class="n">welcome_url</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<%= link_to 'welcome', welcome_url %>
">Copy</button>
</div>
<p>Al usar la URL completa, tus enlaces ahora funcionarán en tus correos electrónicos.</p><h4 id="generación-de-urls-con-url-for"><a class="anchorlink" href="#generación-de-urls-con-url-for"><span>2.7.1</span> Generación de URLs con <code>url_for</code></a></h4><p><a href="https://edgeapi.rubyonrails.org/classes/ActionView/RoutingUrlFor.html#method-i-url_for"><code>url_for</code></a> genera una URL completa por defecto en las plantillas.</p><p>Si no configuraste la opción <code>:host</code> globalmente, asegúrate de pasarla a <code>url_for</code>.</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%=</span> <span class="n">url_for</span><span class="p">(</span><span class="ss">host: </span><span class="s1">'example.com'</span><span class="p">,</span>
<span class="ss">controller: </span><span class="s1">'welcome'</span><span class="p">,</span>
<span class="ss">action: </span><span class="s1">'greeting'</span><span class="p">)</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<%= url_for(host: 'example.com',
controller: 'welcome',
action: 'greeting') %>
">Copy</button>
</div>
<h4 id="generación-de-urls-con-rutas-nombradas"><a class="anchorlink" href="#generación-de-urls-con-rutas-nombradas"><span>2.7.2</span> Generación de URLs con Rutas Nombradas</a></h4><p>Los clientes de correo electrónico no tienen contexto web y, por lo tanto, las rutas no tienen una URL base para formar direcciones web completas. Por lo tanto, siempre debes usar la variante <code>*_url</code> de los helpers de ruta nombrada.</p><p>Si no configuraste la opción <code>:host</code> globalmente, asegúrate de pasarla al helper de URL.</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%=</span> <span class="n">user_url</span><span class="p">(</span><span class="vi">@user</span><span class="p">,</span> <span class="ss">host: </span><span class="s1">'example.com'</span><span class="p">)</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<%= user_url(@user, host: 'example.com') %>
">Copy</button>
</div>
<h3 id="agregar-imágenes-en-vistas-de-action-mailer"><a class="anchorlink" href="#agregar-imágenes-en-vistas-de-action-mailer"><span>2.8</span> Agregar Imágenes en Vistas de Action Mailer</a></h3><p>A diferencia de los controladores, la instancia del mailer no tiene ningún contexto sobre la solicitud entrante, por lo que necesitarás proporcionar el parámetro <code>:asset_host</code> tú mismo.</p><p>Como el <code>:asset_host</code> generalmente es consistente en toda la aplicación, puedes configurarlo globalmente en <code>config/application.rb</code>:</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="n">config</span><span class="p">.</span><span class="nf">action_mailer</span><span class="p">.</span><span class="nf">asset_host</span> <span class="o">=</span> <span class="s1">'http://example.com'</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="config.action_mailer.asset_host = 'http://example.com'
">Copy</button>
</div>
<p>NOTA: Como no podemos inferir el protocolo de la solicitud, necesitarás especificar un protocolo como <code>http://</code> o <code>https://</code> en la configuración de <code>:asset_host</code>.</p><p>Ahora puedes mostrar una imagen dentro de tu correo electrónico.</p><div class="interstitial code">
<pre><code class="highlight erb"><span class="cp"><%=</span> <span class="n">image_tag</span> <span class="s1">'image.jpg'</span> <span class="cp">%></span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="<%= image_tag 'image.jpg' %>
">Copy</button>
</div>
<h3 id="envío-de-correos-electrónicos-multipart"><a class="anchorlink" href="#envío-de-correos-electrónicos-multipart"><span>2.9</span> Envío de Correos Electrónicos Multipart</a></h3><p>Action Mailer enviará automáticamente correos electrónicos multipart si tienes diferentes plantillas para la misma acción. Así que, para nuestro ejemplo de <code>UserMailer</code>, si tienes <code>welcome_email.text.erb</code> y <code>welcome_email.html.erb</code> en <code>app/views/user_mailer</code>, Action Mailer enviará automáticamente un correo electrónico multipart con las versiones HTML y de texto configuradas como diferentes partes.</p><p>El orden de las partes que se insertan está determinado por <code>:parts_order</code> dentro del método <code>ActionMailer::Base.default</code>.</p><h3 id="envío-de-correos-electrónicos-con-opciones-de-entrega-dinámicas"><a class="anchorlink" href="#envío-de-correos-electrónicos-con-opciones-de-entrega-dinámicas"><span>2.10</span> Envío de Correos Electrónicos con Opciones de Entrega Dinámicas</a></h3><p>Si deseas anular las opciones de entrega predeterminadas (por ejemplo, credenciales SMTP) mientras envías correos electrónicos, puedes hacerlo usando <code>delivery_method_options</code> en la acción del mailer.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span>
<span class="vi">@url</span> <span class="o">=</span> <span class="n">user_url</span><span class="p">(</span><span class="vi">@user</span><span class="p">)</span>
<span class="n">delivery_options</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">user_name: </span><span class="n">params</span><span class="p">[</span><span class="ss">:company</span><span class="p">].</span><span class="nf">smtp_user</span><span class="p">,</span>
<span class="ss">password: </span><span class="n">params</span><span class="p">[</span><span class="ss">:company</span><span class="p">].</span><span class="nf">smtp_password</span><span class="p">,</span>
<span class="ss">address: </span><span class="n">params</span><span class="p">[</span><span class="ss">:company</span><span class="p">].</span><span class="nf">smtp_host</span> <span class="p">}</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="vi">@user</span><span class="p">.</span><span class="nf">email</span><span class="p">,</span>
<span class="ss">subject: </span><span class="s2">"Please see the Terms and Conditions attached"</span><span class="p">,</span>
<span class="ss">delivery_method_options: </span><span class="n">delivery_options</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
def welcome_email
@user = params[:user]
@url = user_url(@user)
delivery_options = { user_name: params[:company].smtp_user,
password: params[:company].smtp_password,
address: params[:company].smtp_host }
mail(to: @user.email,
subject: "Please see the Terms and Conditions attached",
delivery_method_options: delivery_options)
end
end
">Copy</button>
</div>
<h3 id="envío-de-correos-electrónicos-sin-renderizado-de-plantilla"><a class="anchorlink" href="#envío-de-correos-electrónicos-sin-renderizado-de-plantilla"><span>2.11</span> Envío de Correos Electrónicos sin Renderizado de Plantilla</a></h3><p>Puede haber casos en los que desees omitir el paso de renderizado de plantilla y proporcionar el cuerpo del correo electrónico como una cadena. Puedes lograr esto usando la opción <code>:body</code>. En tales casos, no olvides agregar la opción <code>:content_type</code>. Rails predeterminadamente usará <code>text/plain</code> de lo contrario.</p><div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="k">def</span> <span class="nf">welcome_email</span>
<span class="n">mail</span><span class="p">(</span><span class="ss">to: </span><span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">].</span><span class="nf">email</span><span class="p">,</span>
<span class="ss">body: </span><span class="n">params</span><span class="p">[</span><span class="ss">:email_body</span><span class="p">],</span>
<span class="ss">content_type: </span><span class="s2">"text/html"</span><span class="p">,</span>
<span class="ss">subject: </span><span class="s2">"Already rendered!"</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
def welcome_email
mail(to: params[:user].email,
body: params[:email_body],
content_type: "text/html",
subject: "Already rendered!")
end
end
">Copy</button>
</div>
<h2 id="callbacks-de-action-mailer"><a class="anchorlink" href="#callbacks-de-action-mailer"><span>3</span> Callbacks de Action Mailer</a></h2><p>Action Mailer te permite especificar un <a href="https://edgeapi.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-before_action"><code>before_action</code></a>, <a href="https://edgeapi.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-after_action"><code>after_action</code></a> y <a href="https://edgeapi.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-around_action"><code>around_action</code></a> para configurar el mensaje, y <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Callbacks/ClassMethods.html#method-i-before_deliver"><code>before_deliver</code></a>, <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Callbacks/ClassMethods.html#method-i-after_deliver"><code>after_deliver</code></a> y <a href="https://edgeapi.rubyonrails.org/classes/ActionMailer/Callbacks/ClassMethods.html#method-i-around_deliver"><code>around_deliver</code></a> para controlar la entrega.</p>
<ul>
<li><p>Los callbacks pueden especificarse con un bloque o un símbolo a un método en la clase del mailer similar a los controladores.</p></li>
<li><p>Podrías usar un <code>before_action</code> para establecer variables de instancia, poblar el objeto de correo con valores predeterminados o insertar encabezados y archivos adjuntos predeterminados.</p></li>
</ul>
<div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">InvitationsMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">before_action</span> <span class="ss">:set_inviter_and_invitee</span>
<span class="n">before_action</span> <span class="p">{</span> <span class="vi">@account</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:inviter</span><span class="p">].</span><span class="nf">account</span> <span class="p">}</span>
<span class="n">default</span> <span class="ss">to: </span><span class="o">-></span> <span class="p">{</span> <span class="vi">@invitee</span><span class="p">.</span><span class="nf">email_address</span> <span class="p">},</span>
<span class="ss">from: </span><span class="o">-></span> <span class="p">{</span> <span class="n">common_address</span><span class="p">(</span><span class="vi">@inviter</span><span class="p">)</span> <span class="p">},</span>
<span class="ss">reply_to: </span><span class="o">-></span> <span class="p">{</span> <span class="vi">@inviter</span><span class="p">.</span><span class="nf">email_address_with_name</span> <span class="p">}</span>
<span class="k">def</span> <span class="nf">account_invitation</span>
<span class="n">mail</span> <span class="ss">subject: </span><span class="s2">"</span><span class="si">#{</span><span class="vi">@inviter</span><span class="p">.</span><span class="nf">name</span><span class="si">}</span><span class="s2"> invited you to their Basecamp (</span><span class="si">#{</span><span class="vi">@account</span><span class="p">.</span><span class="nf">name</span><span class="si">}</span><span class="s2">)"</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">project_invitation</span>
<span class="vi">@project</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:project</span><span class="p">]</span>
<span class="vi">@summarizer</span> <span class="o">=</span> <span class="no">ProjectInvitationSummarizer</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="vi">@project</span><span class="p">.</span><span class="nf">bucket</span><span class="p">)</span>
<span class="n">mail</span> <span class="ss">subject: </span><span class="s2">"</span><span class="si">#{</span><span class="vi">@inviter</span><span class="p">.</span><span class="nf">name</span><span class="p">.</span><span class="nf">familiar</span><span class="si">}</span><span class="s2"> added you to a project in Basecamp (</span><span class="si">#{</span><span class="vi">@account</span><span class="p">.</span><span class="nf">name</span><span class="si">}</span><span class="s2">)"</span>
<span class="k">end</span>
<span class="kp">private</span>
<span class="k">def</span> <span class="nf">set_inviter_and_invitee</span>
<span class="vi">@inviter</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:inviter</span><span class="p">]</span>
<span class="vi">@invitee</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:invitee</span><span class="p">]</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class InvitationsMailer < ApplicationMailer
before_action :set_inviter_and_invitee
before_action { @account = params[:inviter].account }
default to: -> { @invitee.email_address },
from: -> { common_address(@inviter) },
reply_to: -> { @inviter.email_address_with_name }
def account_invitation
mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
end
def project_invitation
@project = params[:project]
@summarizer = ProjectInvitationSummarizer.new(@project.bucket)
mail subject: "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
end
private
def set_inviter_and_invitee
@inviter = params[:inviter]
@invitee = params[:invitee]
end
end
">Copy</button>
</div>
<ul>
<li><p>Podrías usar un <code>after_action</code> para hacer una configuración similar a un <code>before_action</code> pero usando variables de instancia establecidas en tu acción del mailer.</p></li>
<li><p>Usar un callback <code>after_action</code> también te permite anular la configuración del método de entrega actualizando <code>mail.delivery_method.settings</code>.</p></li>
</ul>
<div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">before_action</span> <span class="p">{</span> <span class="vi">@business</span><span class="p">,</span> <span class="vi">@user</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:business</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="ss">:user</span><span class="p">]</span> <span class="p">}</span>
<span class="n">after_action</span> <span class="ss">:set_delivery_options</span><span class="p">,</span>
<span class="ss">:prevent_delivery_to_guests</span><span class="p">,</span>
<span class="ss">:set_business_headers</span>
<span class="k">def</span> <span class="nf">feedback_message</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">campaign_message</span>
<span class="k">end</span>
<span class="kp">private</span>
<span class="k">def</span> <span class="nf">set_delivery_options</span>
<span class="c1"># You have access to the mail instance,</span>
<span class="c1"># @business and @user instance variables here</span>
<span class="k">if</span> <span class="vi">@business</span> <span class="o">&&</span> <span class="vi">@business</span><span class="p">.</span><span class="nf">has_smtp_settings?</span>
<span class="n">mail</span><span class="p">.</span><span class="nf">delivery_method</span><span class="p">.</span><span class="nf">settings</span><span class="p">.</span><span class="nf">merge!</span><span class="p">(</span><span class="vi">@business</span><span class="p">.</span><span class="nf">smtp_settings</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">prevent_delivery_to_guests</span>
<span class="k">if</span> <span class="vi">@user</span> <span class="o">&&</span> <span class="vi">@user</span><span class="p">.</span><span class="nf">guest?</span>
<span class="n">mail</span><span class="p">.</span><span class="nf">perform_deliveries</span> <span class="o">=</span> <span class="kp">false</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">set_business_headers</span>
<span class="k">if</span> <span class="vi">@business</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">"X-SMTPAPI-CATEGORY"</span><span class="p">]</span> <span class="o">=</span> <span class="vi">@business</span><span class="p">.</span><span class="nf">code</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
before_action { @business, @user = params[:business], params[:user] }
after_action :set_delivery_options,
:prevent_delivery_to_guests,
:set_business_headers
def feedback_message
end
def campaign_message
end
private
def set_delivery_options
# You have access to the mail instance,
# @business and @user instance variables here
if @business && @business.has_smtp_settings?
mail.delivery_method.settings.merge!(@business.smtp_settings)
end
end
def prevent_delivery_to_guests
if @user && @user.guest?
mail.perform_deliveries = false
end
end
def set_business_headers
if @business
headers["X-SMTPAPI-CATEGORY"] = @business.code
end
end
end
">Copy</button>
</div>
<ul>
<li>Podrías usar un <code>after_deliver</code> para registrar la entrega del mensaje. También permite comportamientos similares a observadores/interceptores, pero con acceso al contexto completo del mailer.</li>
</ul>
<div class="interstitial code">
<pre><code class="highlight ruby"><span class="k">class</span> <span class="nc">UserMailer</span> <span class="o"><</span> <span class="no">ApplicationMailer</span>
<span class="n">after_deliver</span> <span class="ss">:mark_delivered</span>
<span class="n">before_deliver</span> <span class="ss">:sandbox_staging</span>
<span class="n">after_deliver</span> <span class="ss">:observe_delivery</span>
<span class="k">def</span> <span class="nf">feedback_message</span>
<span class="vi">@feedback</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="ss">:feedback</span><span class="p">]</span>
<span class="k">end</span>
<span class="kp">private</span>
<span class="k">def</span> <span class="nf">mark_delivered</span>
<span class="n">params</span><span class="p">[</span><span class="ss">:feedback</span><span class="p">].</span><span class="nf">touch</span><span class="p">(</span><span class="ss">:delivered_at</span><span class="p">)</span>
<span class="k">end</span>
<span class="c1"># An Interceptor alternative.</span>
<span class="k">def</span> <span class="nf">sandbox_staging</span>
<span class="n">message</span><span class="p">.</span><span class="nf">to</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'[email protected]'</span><span class="p">]</span> <span class="k">if</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">env</span><span class="p">.</span><span class="nf">staging?</span>
<span class="k">end</span>
<span class="c1"># A callback has more context than the comparable Observer example.</span>
<span class="k">def</span> <span class="nf">observe_delivery</span>
<span class="no">EmailDelivery</span><span class="p">.</span><span class="nf">log</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="nb">self</span><span class="p">.</span><span class="nf">class</span><span class="p">,</span> <span class="n">action_name</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="class UserMailer < ApplicationMailer
after_deliver :mark_delivered
before_deliver :sandbox_staging
after_deliver :observe_delivery
def feedback_message
@feedback = params[:feedback]
end
private
def mark_delivered
params[:feedback].touch(:delivered_at)