mail-merge: document RT setup better
authorAlex Dehnert <adehnert@mit.edu>
Sun, 10 Mar 2013 23:34:24 +0000 (19:34 -0400)
committerAlex Dehnert <adehnert@mit.edu>
Sun, 10 Mar 2013 23:34:24 +0000 (19:34 -0400)
mail-merge-help/README

index a328099910578644630573c1c4f7319ff05baca3..b0be8a10c7599970812631ae470f08e430a52ce2 100644 (file)
@@ -31,7 +31,31 @@ Please feel free to contact me (adehnert@mit.edu) with any questions.
 Using mail-merge with RT
 ------------------------
 
-mail-merge now supports limited RT interaction. To use with RT, you should:
+mail-merge now supports limited RT interaction.
+
+
+One-time set-up
+~~~~~~~~~~~~~~~
+
+To do this, mail-merge needs to know your RT username and password. It
+automatically read it from the same `~/.rtrc` that the command-line RT client
+will use. You should create a file called .rtrc in your home directory
+containing:
+
+"""
+server https://help.mit.edu/
+user your-username
+passwd your-password
+query ( Status='new' or Status='open' or Status='stalled' )
+"""
+
+If you don't have a password for RT (separate from your Athena password), you
+can set one at https://help.mit.edu/User/Prefs.html.
+
+Usage
+~~~~~
+
+To use RT for a given mail-merge operation, you should:
 
 * Use the --rt-queue option, passing the queue name (if it contains no spaces)
   or ID number (which can be found on https://help.mit.edu/Admin/Queues/)