Index: README.txt
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/mimemail/README.txt,v
retrieving revision 1.1
diff -u -p -r1.1 README.txt
--- README.txt	17 Nov 2005 02:56:38 -0000	1.1
+++ README.txt	6 Apr 2010 13:15:47 -0000
@@ -12,20 +12,35 @@ USAGE
   useful by itself. Once installed, any module can send messages by 
   calling the mimemail() function:
 	
-	$sender     - a user object or email address
-	$recipient  - a user object or email address
-	$subject    - subject line
-	$body       - body text in html format
-	$plaintext  - boolean, whether to send messages in plaintext-only
-	            (default false)
+	$sender      - a user object, text email address or an array with name, mail
+	$recipient   - a user object, text email address or an array with name, mail
+	$subject     - subject line
+	$body        - body text in html format
+	$plaintext   - boolean, whether to send messages in plaintext-only
+	               (default false)
+	$headers     - a keyed array with headers (optional)
+  $text        - plaintext portion of a multipart e-mail (optional)
+  $attachments - array of arrays with the file's path and MIME type (optional)
+  $mailkey     - message identifier
+  
+  return       - an array containing the MIME encoded message
 
   This module creates a user preference for receiving plaintext-only
-  messages.  This preference will be honored by all calls to mimemail()
+  messages. This preference will be honored by all calls to mimemail()
+  
+  Email messages are formatted using the mimemail.tpl.php template. This
+  includes a css style sheet and uses a compresses HTML version of the text.
+  The included CSS is:
+    the mail.css file found in your default theme
+    or the combined CSS style sheets of your default theme.
   
-  Messages are formatting using theme_mimemail_message($body), which
-  includes all css files from the currently active theme and compresses
-  the HTML version of the text.  Create a new theme function if your 
-  web stylesheets are too heavy for this.
+  To create a custom email template copy the mimemail.tpl.php file from the
+  mimemail/theme directory into your default template folder. If you are using
+  a different administration theme than your default theme, you have to place
+  the mimemail.tpl.php into that theme folder.
+
+  To embed images into emails you have to use relative paths. Images with
+  absolute path will be available as remote content.
   
 CREDITS