You are here

README.txt in Mime Mail 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
INSTALLATION
	Hopefully, you know the drill by now :)
	1. Place the entire mimemail directory into your Drupal modules 
	   directory.
	2. Enable the mimemail module by navigating to:
     administer > modules
    
USAGE
  This module may be required by other modules, but is not terribly
  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)

  This module creates a user preference for receiving plaintext-only
  messages.  This preference will be honored by all calls to mimemail()
  
  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.
  
CREDITS

	MAINTAINER: Allie Micka < allie at pajunas dot com > 
	
	* Allie Micka
	  Mime enhancements and HTML mail code
	  
	* Gerhard Killesreiter
	  Original mail and mime code
	  
  * Robert Castelo
    	HTML to Text and other functionality 

File

README.txt
View source
  1. INSTALLATION
  2. Hopefully, you know the drill by now :)
  3. 1. Place the entire mimemail directory into your Drupal modules
  4. directory.
  5. 2. Enable the mimemail module by navigating to:
  6. administer > modules
  7. USAGE
  8. This module may be required by other modules, but is not terribly
  9. useful by itself. Once installed, any module can send messages by
  10. calling the mimemail() function:
  11. $sender - a user object or email address
  12. $recipient - a user object or email address
  13. $subject - subject line
  14. $body - body text in html format
  15. $plaintext - boolean, whether to send messages in plaintext-only
  16. (default false)
  17. This module creates a user preference for receiving plaintext-only
  18. messages. This preference will be honored by all calls to mimemail()
  19. Messages are formatting using theme_mimemail_message($body), which
  20. includes all css files from the currently active theme and compresses
  21. the HTML version of the text. Create a new theme function if your
  22. web stylesheets are too heavy for this.
  23. CREDITS
  24. MAINTAINER: Allie Micka < allie at pajunas dot com >
  25. * Allie Micka
  26. Mime enhancements and HTML mail code
  27. * Gerhard Killesreiter
  28. Original mail and mime code
  29. * Robert Castelo
  30. HTML to Text and other functionality