@@ -70,14 +70,16 @@ class Message < ActiveRecord::Base end alias_method :bcc=, :bcc - # Forwards this message + # Forwards this message, including the original subject and body in the new + # message def forward message = self.class.new(:subject => subject, :body => body) message.sender = sender message end - # Replies to this message + # Replies to this message, including the original subject and body in the new + # message. Only the original direct receivers are added to the reply. def reply message = self.class.new(:subject => subject, :body => body) message.sender = sender @@ -85,7 +87,9 @@ class Message < ActiveRecord::Base message end - # Replies to all recipients on this message + # Replies to all recipients on this message, including the original subject + # and body in the new message. All receivers (direct, cc, and bcc) are added + # to the reply. def reply_to_all message = reply message.cc(cc) app/models/message.rb @@ -55,14 +55,16 @@ class MessageRecipient < ActiveRecord::Base end end - # Forwards the message + # Forwards this message, including the original subject and body in the new + # message def forward message = self.message.class.new(:subject => subject, :body => body) message.sender = receiver message end - # Replies to the message + # Replies to this message, including the original subject and body in the new + # message. Only the original direct receivers are added to the reply. def reply message = self.message.class.new(:subject => subject, :body => body) message.sender = receiver @@ -70,7 +72,9 @@ class MessageRecipient < ActiveRecord::Base message end - # Replies to all recipients on the message, including the original sender + # Replies to all recipients on this message, including the original subject + # and body in the new message. All receivers (sender, direct, cc, and bcc) are + # added to the reply. def reply_to_all message = reply message.to(to - [receiver] + [sender]) app/models/message_recipient.rb @@ -57,12 +57,14 @@ module PluginAWeek #:nodoc: end module InstanceMethods - # Composed messages that have not yet been sent + # Composed messages that have not yet been sent. These consists of all + # messages that are currently in the "unsent" state. def unsent_messages messages.with_state('unsent') end - # Composed messages that have already been sent + # Composed messages that have already been sent. These consists of all + # messages that are currently in the "queued" or "sent" states. def sent_messages messages.with_states(%w(queued sent)) end lib/has_messages.rb 8850e9cbca6fdeacd91b09e6e72b263e3c2b0582 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/has_messages/commit/c8870feb561fe6ff808a8674aa4ed6e6a7eb98d3 c8870feb561fe6ff808a8674aa4ed6e6a7eb98d3 2008-07-04T20:43:53-07:00 2008-07-04T20:43:53-07:00 Add more documentation 53559e532e53bc2e2df8926ea71fd97ff690a52c Aaron Pfeifer aaron.pfeifer@gmail.com