aboutsummaryrefslogtreecommitdiffstats
path: root/railties/generators/mailer/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/generators/mailer/USAGE')
-rw-r--r--railties/generators/mailer/USAGE29
1 files changed, 29 insertions, 0 deletions
diff --git a/railties/generators/mailer/USAGE b/railties/generators/mailer/USAGE
new file mode 100644
index 0000000000..b6f2bbd54b
--- /dev/null
+++ b/railties/generators/mailer/USAGE
@@ -0,0 +1,29 @@
+NAME
+ new_mailer - create mailer and view stub files
+
+SYNOPSIS
+ new_mailer MailerName action [action ...]
+
+DESCRIPTION
+ The new_mailer generator takes the name of the new mailer class as the
+ first argument and a variable number of mail action names as subsequent
+ arguments.
+
+ From the passed arguments, new_mailer generates a class file in
+ app/models with a mail action for each of the mail action names passed.
+ It then creates a mail test suite in test/unit with one stub test case
+ and one stub fixture per mail action. Finally, it creates a template stub
+ for each of the mail action names in app/views under a directory with the
+ same name as the class.
+
+EXAMPLE
+ new_mailer Notifications signup forgot_password invoice
+
+ This will generate a Notifications class in
+ app/models/notifications.rb, a NotificationsTest in
+ test/unit/notifications_test.rb, and signup, forgot_password, and invoice
+ in test/fixture/notification. It will also create signup.rhtml,
+ forgot_password.rhtml, and invoice.rhtml in app/views/notifications.
+
+ The Notifications class will have the following methods: signup,
+ forgot_password, and invoice.