Document everything with YARD and fix some bugs along the way.
[mailshears.git] / lib / rm / plugins / dovecot.rb
index 0ced5bec3acf4aca70bbdd7008882112c78ba412..7babfbeb40d353f212459f0a040da3c9d0d6f8bb 100644 (file)
@@ -1,16 +1,24 @@
-# Needed for rm_r.
 require 'fileutils'
 
 require 'common/dovecot_plugin'
 require 'rm/rm_plugin'
 
+
+# Handle the removal of users and domains from the Dovecot mailstore
+# (the filesystem).
+#
 class DovecotRm
 
   include DovecotPlugin
   include RmPlugin
 
 
-  def delete_domain(domain)
+  # Remove *domain* from the Dovecot mailstore. This just runs "rm -r"
+  # on the domain directory if it exists.
+  #
+  # @param domain [Domain] the domain to remove.
+  #
+  def remove_domain(domain)
     domain_path = self.get_domain_path(domain)
 
     if not File.directory?(domain_path)
@@ -20,7 +28,14 @@ class DovecotRm
     FileUtils.rm_r(domain_path)
   end
 
-  def delete_user(user)
+
+  # Remove *user* from the Dovecot mailstore. This just runs "rm -r"
+  # on the *user*'s mailbox directory, if it exists.
+  #
+  # @param user [User] the user whose mailbox directory we want to
+  #   remove.
+  #
+  def remove_user(user)
     user_path = self.get_user_path(user)
 
     if not File.directory?(user_path)