You are here

README.txt in PHPMailer 7.3

-- SUMMARY --

Adds SMTP support for sending e-mails using the PHPMailer library.

For a full description of the module, visit the project page:
  http://drupal.org/project/phpmailer
To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/phpmailer


-- REQUIREMENTS --

* Access to an SMTP server

* Libraries API module
  http://drupal.org/project/libraries

* PHPMailer library
  https://github.com/PHPMailer/PHPMailer

Optional:

* To connect to an SMTP server using SSL, your PHP installation needs to have
  OpenSSL support.

* Mime Mail module to send HTML e-mails
  http://drupal.org/project/mimemail

* Personalized E-mails module to adjust the displayed sender name
  http://drupal.org/project/pmail


-- INSTALLATION --

1. Download the latest PHPMailer library from

     https://github.com/PHPMailer/PHPMailer/tags

   and extract the following files into a 'phpmailer' library directory:

     sites/all/libraries/phpmailer/class.phpmailer.php
     sites/all/libraries/phpmailer/class.smtp.php

   It is recommended that you create your libraries directory at one of the
   following locations:

     sites/all/libraries/phpmailer
     sites/<site>/libraries/phpmailer

   Consult the Libraries API documentation for further information.

2. Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Configure user permissions at Administer >> User management >> Access
  control >> phpmailer module.

  Only users with the "administer phpmailer settings" permission are allowed to
  access the module configuration page.

* Configure your SMTP server settings at Administer >> Site
  configuration >> PHPMailer.

  If used in conjunction with Mime Mail, PHPMailer will show up as an e-mail
  engine in the Mime Mail module settings.  To let Mime Mail apply styles and
  formatting to system e-mails but still use PHPMailer for mail transport,
  uncheck "Use PHPMailer to send e-mails" first on the PHPMailer settings
  page.  Then activate "Use mime mail for all messages" on the Mime Mail
  settings page and choose PHPMailer from the list of available e-mail engines.

* Using Google Mail or Google Apps as SMTP server

  To send e-mails with Google Mail use the following settings:

    SMTP server:     smtp.gmail.com
    SMTP port:       465
    Secure protocol: SSL
    Username:        your_google_mail_name@gmail.com
      or:            your_username@your_google_apps_domain.com
    Password:        your_google_mail_password

  In Advanced SMTP settings:
    Enable 'Always set "Reply-To" address' checkbox.

  Also note the sending limits for Google Mail accounts:
  http://mail.google.com/support/bin/answer.py?hl=en&answer=22839

  General instructions for Google Mail accounts:
  http://mail.google.com/support/bin/answer.py?answer=13287

* Using other popular freemailers as SMTP server

  See http://phpmailer.worxware.com/index.php?pg=tip_srvrs.

* Errors when trying to send a test email

  If you see the following error messages when trying to send a test email from
  the settings page:

    SMTP -> ERROR: Failed to connect to server: Connection timed out (110)
    SMTP Error: Could not connect to SMTP host. 

  it means the mail server can not be reached, usually because your hosting
  provider is blocking the port by a firewall. The solution is to ask your
  provider to allow outgoing connections to your mail server.

* Debug settings

  PHPMailer supports rerouting all e-mails for debugging purposes, to prevent
  you from accidentally sending out e-mails to real users from a development
  site.  To enable this feature, add the following lines to the end of your
  settings.php (usually located in sites/default):

    $conf['phpmailer_debug_email'] = 'your_debug_email@yoursite.com';

  This will change the recipient of all e-mails to the configured address.


-- CREDITS --

Authors:
* Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898
* Daniel F. Kudwien (sun) - http://drupal.org/user/54136

This project has been sponsored by UNLEASHED MIND.

File

README.txt
View source
  1. -- SUMMARY --
  2. Adds SMTP support for sending e-mails using the PHPMailer library.
  3. For a full description of the module, visit the project page:
  4. http://drupal.org/project/phpmailer
  5. To submit bug reports and feature suggestions, or to track changes:
  6. http://drupal.org/project/issues/phpmailer
  7. -- REQUIREMENTS --
  8. * Access to an SMTP server
  9. * Libraries API module
  10. http://drupal.org/project/libraries
  11. * PHPMailer library
  12. https://github.com/PHPMailer/PHPMailer
  13. Optional:
  14. * To connect to an SMTP server using SSL, your PHP installation needs to have
  15. OpenSSL support.
  16. * Mime Mail module to send HTML e-mails
  17. http://drupal.org/project/mimemail
  18. * Personalized E-mails module to adjust the displayed sender name
  19. http://drupal.org/project/pmail
  20. -- INSTALLATION --
  21. 1. Download the latest PHPMailer library from
  22. https://github.com/PHPMailer/PHPMailer/tags
  23. and extract the following files into a 'phpmailer' library directory:
  24. sites/all/libraries/phpmailer/class.phpmailer.php
  25. sites/all/libraries/phpmailer/class.smtp.php
  26. It is recommended that you create your libraries directory at one of the
  27. following locations:
  28. sites/all/libraries/phpmailer
  29. sites//libraries/phpmailer
  30. Consult the Libraries API documentation for further information.
  31. 2. Install as usual, see http://drupal.org/node/70151 for further information.
  32. -- CONFIGURATION --
  33. * Configure user permissions at Administer >> User management >> Access
  34. control >> phpmailer module.
  35. Only users with the "administer phpmailer settings" permission are allowed to
  36. access the module configuration page.
  37. * Configure your SMTP server settings at Administer >> Site
  38. configuration >> PHPMailer.
  39. If used in conjunction with Mime Mail, PHPMailer will show up as an e-mail
  40. engine in the Mime Mail module settings. To let Mime Mail apply styles and
  41. formatting to system e-mails but still use PHPMailer for mail transport,
  42. uncheck "Use PHPMailer to send e-mails" first on the PHPMailer settings
  43. page. Then activate "Use mime mail for all messages" on the Mime Mail
  44. settings page and choose PHPMailer from the list of available e-mail engines.
  45. * Using Google Mail or Google Apps as SMTP server
  46. To send e-mails with Google Mail use the following settings:
  47. SMTP server: smtp.gmail.com
  48. SMTP port: 465
  49. Secure protocol: SSL
  50. Username: your_google_mail_name@gmail.com
  51. or: your_username@your_google_apps_domain.com
  52. Password: your_google_mail_password
  53. In Advanced SMTP settings:
  54. Enable 'Always set "Reply-To" address' checkbox.
  55. Also note the sending limits for Google Mail accounts:
  56. http://mail.google.com/support/bin/answer.py?hl=en&answer=22839
  57. General instructions for Google Mail accounts:
  58. http://mail.google.com/support/bin/answer.py?answer=13287
  59. * Using other popular freemailers as SMTP server
  60. See http://phpmailer.worxware.com/index.php?pg=tip_srvrs.
  61. * Errors when trying to send a test email
  62. If you see the following error messages when trying to send a test email from
  63. the settings page:
  64. SMTP -> ERROR: Failed to connect to server: Connection timed out (110)
  65. SMTP Error: Could not connect to SMTP host.
  66. it means the mail server can not be reached, usually because your hosting
  67. provider is blocking the port by a firewall. The solution is to ask your
  68. provider to allow outgoing connections to your mail server.
  69. * Debug settings
  70. PHPMailer supports rerouting all e-mails for debugging purposes, to prevent
  71. you from accidentally sending out e-mails to real users from a development
  72. site. To enable this feature, add the following lines to the end of your
  73. settings.php (usually located in sites/default):
  74. $conf['phpmailer_debug_email'] = 'your_debug_email@yoursite.com';
  75. This will change the recipient of all e-mails to the configured address.
  76. -- CREDITS --
  77. Authors:
  78. * Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898
  79. * Daniel F. Kudwien (sun) - http://drupal.org/user/54136
  80. This project has been sponsored by UNLEASHED MIND.