You are here

README.txt in PHPMailer 8.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

* 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. Execute 'composer update' from the site's root directory (this will download
   the PHPMailer library.

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