¿Cómo obtengo una vista previa de los correos electrónicos en Rails?

116

Esta puede ser una pregunta tonta, pero cuando estoy armando un correo electrónico HTML en Rails, ¿hay una forma incorporada particularmente fácil de obtener una vista previa de la plantilla en el navegador o necesito escribir algún tipo de controlador personalizado que lo extraiga? en como su vista?

Peter Nixey
fuente
2
Aparentemente no hay preguntas tontas: D
knagode

Respuestas:

133

Action Mailer ahora tiene una forma integrada de obtener una vista previa de los correos electrónicos en Rails 4.1 . Por ejemplo, mira esto:

# located in test/mailers/previews/notifier_mailer_preview.rb

class NotifierPreview < ActionMailer::Preview
  # Accessible from http://localhost:3000/rails/mailers/notifier/welcome
  def welcome
    Notifier.welcome(User.first)
  end
end
benjaminjosephw
fuente
5
@andres Estoy bastante seguro de que eso es por diseño: no desea que los usuarios obtengan una vista previa de su correo en servidores de producción, está destinado solo para el desarrollo local.
Creado el
1
@mpowered ¿Y qué sucede si QUIERO que los usuarios puedan obtener una vista previa / modificar los correos que están a punto de enviar? (Por ejemplo: un gerente rechaza una solicitud de usuario y se envía un correo electrónico para advertir al solicitante)
Cyril Duchon-Doris
2
@CyrilDD Tendrías que construir algo así tú mismo, no creo que esta sea la herramienta para ese trabajo.
benjaminjosephw
1
La vista previa está disponible en localhost: 3000 / rails / mailers / notifier / welcome , y una lista de ellos en localhost: 3000 / rails / mailers .
zires
8
Si está utilizando Rspec, sus vistas previas vanspec/mailers/previews
Drew Stephens
73

La respuesta de Daniel es un buen comienzo, pero si sus plantillas de correo electrónico contienen datos dinámicos, no funcionará. Por ejemplo, suponga que su correo electrónico es un recibo de pedido y dentro de él lo imprime @order.total_price; utilizando el método anterior, la @ordervariable será nula.

Aquí hay una pequeña receta que utilizo:

Primero, dado que esta funcionalidad de vista previa de correo electrónico es definitivamente solo para uso interno, configuré algunas rutas genéricas en el espacio de nombres de administrador:

#routes.rb

MySite::Application.routes.draw do
  namespace :admin do
    match 'mailer(/:action(/:id(.:format)))' => 'mailer#:action'
  end
end

A continuación, creo el controlador. En este controlador, creo un método por plantilla de correo electrónico. Dado que la mayoría de los correos electrónicos contienen datos dinámicos, necesitamos completar cualquier variable miembro que espere la plantilla.

Esto se podría hacer con accesorios, pero normalmente prefiero capturar algunos datos reales pseudoaleatorios. Recuerde, esta NO es una prueba unitaria, es puramente una ayuda al desarrollo. No es necesario que produzca el mismo resultado todas las veces; de hecho, ¡probablemente sea mejor si no lo hace!

#app/controllers/admin/mailer_controller.rb
class Admin::MailerController < Admin::ApplicationController

  def preview_welcome()
    @user = User.last
    render :file => 'mailer/welcome.html.erb', :layout => 'mailer'
  end

end

Tenga en cuenta que cuando renderizamos la plantilla, usamos layout=>:mailer. Esto incrusta el cuerpo de su correo electrónico dentro del diseño de correo electrónico HTML que ha creado en lugar de dentro de su diseño de aplicación web típico (por ejemplo application.html.erb).

Y eso es todo. Ahora puedo visitar http://example.com/admin/mailer/preview_welcome para obtener una vista previa del cambio en mi plantilla de correo electrónico de bienvenida.

cailinanne
fuente
De hecho, este fue exactamente el enfoque que había adoptado y que acababa de codificar cuando comencé a leer su respuesta, gracias :)
Peter Nixey
¡Gran respuesta! ¡Exactamente lo que necesitaba!
Kulgar
¡Esa es una receta sabrosa! ¡Gracias por la gran respuesta!
Rob Cooper
¡Esta es una respuesta asombrosa! ¡Gracias!
OzBandit
5
La ruta debería ser get 'mailer...ahora en lugar de match.
Patrick Berkeley
18

37Signals también tiene su propia gema de prueba de correo llamada mail_view . Es bastante fantástico.

Bagazo
fuente
No hay problema. ¿De qué manera terminaste usando?
Marc
Bac, cuando publiqué esto, resolví el problema con un controlador personalizado que escribí yo mismo, pero lo volveré a usar pronto, así que experimentaré con esto
Peter Nixey
16

La configuración más sencilla que he visto es MailCatcher . La instalación tardó 2 minutos y funciona para nuevos correos electrónicos listos para usar.

Galeno
fuente
De hecho, esto es genial. ¡La instalación es muy rápida y funciona para todos los remitentes! ¡Buen consejo!
rept
5

Recientemente escribí una joya llamada Maily para obtener una vista previa, editar (archivo de plantilla) y enviar los correos electrónicos de la aplicación a través de un navegador. También proporciona una forma sencilla de conectar datos, un sistema de autorización flexible y una interfaz de usuario minimalista.

Tengo planeado agregar nuevas funciones en un futuro cercano, como:

  • Múltiples ganchos por correo electrónico
  • Parametrizar correos electrónicos a través de la interfaz de usuario (argumentos del método de correo)
  • Juega con las teclas de traducción (lista, resaltado, ...)

Espero que te pueda ayudar.

mercados
fuente
4

Puede utilizar la vista previa de correo electrónico de Rails

captura de pantalla de rails-email-preview

REP es un motor de rieles para obtener una vista previa y probar el envío de correos electrónicos, con soporte I18n, fácil integración del premailer y edición opcional de CMS con comfortable_mexican_sofa .

glebm
fuente
¿Hay ejemplos de cómo realizar la integración entre REP y CMS?
danieldekay
No conozco ninguna aplicación de demostración, pero hay un artículo
glebm
4

railsgenera una vista previa de correo si usa rails g mailer CustomMailer. Obtendrás un archivo CustomMailerPreviewdentrospec/mailers/previews carpeta.

Aquí puede escribir su método que llamará al correo y generará una vista previa.

Por ex -

class CustomMailerPreview < ActionMailer::Preview
  def contact_us_mail_preview
    CustomMailer.my_mail(user: User.first)
  end
end

Obtenga una vista previa de todos los correos electrónicos en http: // localhost: 3000 / rails / mailers / custom_mailer

Intercambios
fuente
Para mi aplicación con rspec agregué config.action_mailer.preview_path = "#{Rails.root}/spec/mailers/previews"
Mauro
3

Rails Email Preview nos ayuda a ver rápidamente el correo electrónico en el navegador web en modo de desarrollo.

1) Agregue “gem ‘rails_email_preview’, ‘~> 0.2.29’ “al archivo de gemas y agrupe la instalación.

2) Ejecute “rails g rails_email_preview:install”esto crea un inicializador en la carpeta de configuración y agregue rutas.

3) Ejecute “rails g rails_email_preview:update_previews”esta carpeta crates mailer_previews en el directorio de la aplicación.

Generator agregará un código auxiliar a cada uno de sus correos electrónicos y luego completará el código auxiliar con datos simulados.

Ex:

class UserMailerPreview
def invitation
UserMailer.invitation mock_user(‘Alice’), mock_user(‘Bob’)
end
def welcome
UserMailer.welcome mock_user
end
private
def mock_user(name = Bill Gates’)
fake_id User.new(name: name, email: user#{rand 100}@test.com”)
end
def fake_id(obj)
obj.define_singleton_method(:id) { 123 + rand(100) }
obj
end
end

4) Los parámetros en la consulta de búsqueda estarán disponibles como una variable de instancia para obtener una vista previa de la clase. Ej: si tenemos una URL como “/emails/user_mailer_preview-welcome?user_id=1” @user_idse define en el método de bienvenida UserMailerPreview, nos ayuda a enviar correo a un usuario específico.

class UserMailerPreview
def welcome
user = @user_id ? User.find(@user_id) : mock_user
UserMailer.welcome(user)
end
end

5) Para acceder a las URL de REP como esta

rails_email_preview.rep_root_url
rails_email_preview.rep_emails_url
rails_email_preview.rep_email_url(‘user_mailer-welcome’)

6) Podemos enviar correos electrónicos a través de REP, esto utilizará la configuración de correo del entorno. Elimine el comentario de esta línea en el inicializador para deshabilitar el envío de correo en el entorno de prueba.

config.enable_send_email = false

Fuente: Blog de RailsCarma : Vista previa de correos electrónicos en aplicaciones de Rails con la gema Mail_View

Carma Tec
fuente
3

Me sorprende que nadie haya mencionado letter_opener . Es una joya que procesará y abrirá correos electrónicos como una página de navegador cada vez que se entregue un correo electrónico en dev.

KurtPreston
fuente
1
letter_opener es una joya genial y es imprescindible. Pero a veces el correo comienza por eventos especiales que desea evitar jugar para verificar únicamente el html / css del correo.
Mauro
2

No hay forma de obtener una vista previa directamente desde el Mailer. Pero como escribiste, puedes escribir un controlador, que se parece a esto.

class EmailPreviewsControllers < ActionController::Base
  def show
    render "#{params[:mailer]}_mailer/#{params[:method]}"
  end
end

Pero creo que esa no es la mejor manera de probar los correos electrónicos, si se ven correctamente.

Daniel Spangenberg
fuente
3
render "#{params[:mailer]}_mailer/#{params[:method]}", :layout => 'mailer'incrustará el cuerpo del correo electrónico dentro del diseño de correo electrónico HTML que ha creado para su aplicación.
dexter
Gracias por eso, no quiero volver a verificar la compatibilidad del navegador, lo trataría por separado, solo quiero escupirlo rápidamente y ver cómo se ve, creo que su enfoque funciona bien para eso
Peter Nixey
1

Prefiero la gema mails_viewer . Esta joya es bastante útil ya que guarda la plantilla HTML en la carpeta tmp.

Trung Lê
fuente