You are here

README.txt in Mail MIME 7.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 6.2 README.txt
[1]Mail MIME

   Provides a class for creating MIME messages.
     *

        NOTE: This module does not send mail.
                If you came here looking for a mail-sending module, try
                [2]HTML Mail (which can use this module for MIME-handling)
                or [3]Mime Mail (which comes with its own MIME-handling
                library).

   [4]Mail Mime extends certain [5]PEAR mail-handling classes to provide a
   drupal-friendly library for creating and parsing MIME messages. Neither
   [6]Mail Mime nor the original [7]PEAR classes send mail nor do anything
   useful on their own. They are intended as code libraries to be used by
   other programs that send or receive mail.

   [8]Mail Mime started out as part of [9]HTML Mail. I separated into its
   own module for two reasons:
    1. The separation helped clarify in my own mind which parts of the
       mail-sending process require MIME and which do not. The resulting
       code is simpler and easier to maintain.
    2. It is possible that another mail-sending or mail-reading module may
       find the [10]Mail Mime library useful.

  Requirements

   The following files, available from [11]PEAR, must be installed and
   available somewhere on the [12]include_path.
     * Mail/mime.php
     * Mail/mimeDecode.php
     * Mail/mimePart.php
     * PEAR.php
     * PEAR5.php
     * One way to satisfy the requirements is to run the following commands
       from a Unix root shell prompt:
       pear install -a Mail_Mime
       pear install Mail_mimeDecode
       The -a parameter ensures that dependencies, including
       Mail/mimePart.php, are also installed.
     * Another way is to install and enable the [13]Include module before
       enabling the [14]Mail MIME module.
       If the Include module fails to download the mimeDecode.php file
       you have to download this file manually from the [15]PEAR repository
       and move it to the /include directory inside Drupal's default files
       location (usually the path to the file is
       sites/default/files/include/Mail/mimeDecode.php).

  [16]Installation

    1. Download and install [17]as usual.
    2. When enabled, [18]Mail Mime will
          + Auto-detect whether the required files are present.
          + If any files are missing, and the [19]Include module is
            available, [20]Mail Mime will use [21]Include to auto-download
            and enable the missing files.
          + If all of the above fails, [22]Mail Mime will disable itself
            and print a warning to both the screen and the error log.

References

   1. http://drupal.org/project/mailmime
   2. http://drupal.org/project/htmlmail
   3. http://drupal.org/project/mimemail
   4. http://drupal.org/project/mailmime
   5. http://pear.php.net/
   6. http://drupal.org/project/mailmime
   7. http://pear.php.net/
   8. http://drupal.org/project/mailmime
   9. http://drupal.org/project/htmlmai
  10. http://drupal.org/project/mailmime
  11. http://pear.php.net/
  12. http://php.net/manual/ini.core.php#ini.include-path
  13. http://drupal.org/project/include
  14. http://drupal.org/project/mailmime
  15. http://svn.php.net/repository/pear/packages/Mail_mimeDecode/trunk/Mail/mimeDecode.php
  16. http://drupal.org/documentation/install/modules-themes/modules-5-6
  17. http://drupal.org/documentation/install/modules-themes/modules-5-6
  18. http://drupal.org/project/mailmime
  19. http://drupal.org/project/include
  20. http://drupal.org/project/mailmime
  21. http://drupal.org/project/include
  22. http://drupal.org/project/mailmime

File

README.txt
View source
  1. [1]Mail MIME
  2. Provides a class for creating MIME messages.
  3. *
  4. NOTE: This module does not send mail.
  5. If you came here looking for a mail-sending module, try
  6. [2]HTML Mail (which can use this module for MIME-handling)
  7. or [3]Mime Mail (which comes with its own MIME-handling
  8. library).
  9. [4]Mail Mime extends certain [5]PEAR mail-handling classes to provide a
  10. drupal-friendly library for creating and parsing MIME messages. Neither
  11. [6]Mail Mime nor the original [7]PEAR classes send mail nor do anything
  12. useful on their own. They are intended as code libraries to be used by
  13. other programs that send or receive mail.
  14. [8]Mail Mime started out as part of [9]HTML Mail. I separated into its
  15. own module for two reasons:
  16. 1. The separation helped clarify in my own mind which parts of the
  17. mail-sending process require MIME and which do not. The resulting
  18. code is simpler and easier to maintain.
  19. 2. It is possible that another mail-sending or mail-reading module may
  20. find the [10]Mail Mime library useful.
  21. Requirements
  22. The following files, available from [11]PEAR, must be installed and
  23. available somewhere on the [12]include_path.
  24. * Mail/mime.php
  25. * Mail/mimeDecode.php
  26. * Mail/mimePart.php
  27. * PEAR.php
  28. * PEAR5.php
  29. * One way to satisfy the requirements is to run the following commands
  30. from a Unix root shell prompt:
  31. pear install -a Mail_Mime
  32. pear install Mail_mimeDecode
  33. The -a parameter ensures that dependencies, including
  34. Mail/mimePart.php, are also installed.
  35. * Another way is to install and enable the [13]Include module before
  36. enabling the [14]Mail MIME module.
  37. If the Include module fails to download the mimeDecode.php file
  38. you have to download this file manually from the [15]PEAR repository
  39. and move it to the /include directory inside Drupal's default files
  40. location (usually the path to the file is
  41. sites/default/files/include/Mail/mimeDecode.php).
  42. [16]Installation
  43. 1. Download and install [17]as usual.
  44. 2. When enabled, [18]Mail Mime will
  45. + Auto-detect whether the required files are present.
  46. + If any files are missing, and the [19]Include module is
  47. available, [20]Mail Mime will use [21]Include to auto-download
  48. and enable the missing files.
  49. + If all of the above fails, [22]Mail Mime will disable itself
  50. and print a warning to both the screen and the error log.
  51. References
  52. 1. http://drupal.org/project/mailmime
  53. 2. http://drupal.org/project/htmlmail
  54. 3. http://drupal.org/project/mimemail
  55. 4. http://drupal.org/project/mailmime
  56. 5. http://pear.php.net/
  57. 6. http://drupal.org/project/mailmime
  58. 7. http://pear.php.net/
  59. 8. http://drupal.org/project/mailmime
  60. 9. http://drupal.org/project/htmlmai
  61. 10. http://drupal.org/project/mailmime
  62. 11. http://pear.php.net/
  63. 12. http://php.net/manual/ini.core.php#ini.include-path
  64. 13. http://drupal.org/project/include
  65. 14. http://drupal.org/project/mailmime
  66. 15. http://svn.php.net/repository/pear/packages/Mail_mimeDecode/trunk/Mail/mimeDecode.php
  67. 16. http://drupal.org/documentation/install/modules-themes/modules-5-6
  68. 17. http://drupal.org/documentation/install/modules-themes/modules-5-6
  69. 18. http://drupal.org/project/mailmime
  70. 19. http://drupal.org/project/include
  71. 20. http://drupal.org/project/mailmime
  72. 21. http://drupal.org/project/include
  73. 22. http://drupal.org/project/mailmime