You are here

Home » API reference » Postmark 6

README.txt in Postmark 6

Same filename and directory in other branches
  1. 7 README.txt
Module description
------------------

The Postmark module allows the administrator to switch the standard SMTP 
library over to use the third party Postmark library. An account with 
Postmark is required to use this module.

The recommended third party library for this module is the latest version
of the Postmark PHP class v0.4.4 by Markus Hedlund et al.
http://github.com/Znarkus/postmark-php

Note: The module uses the REST API to connect to Postmark.

Installation
------------

Installing the Postmark module requires a few steps :

1) Copy the postmark folder to the modules folder in your installation 
   This is usually sites/all/modules.

2) Obtain the Postmark PHP library from http://github.com/Znarkus/postmark-php.

3) Copy the files to the includes directory in the module folder
   /modules/postmark/includes.

4) You must ensure you get the Certificate folder too as this is now implemented
   within the PHP class.

4) Enable the module using Administer > Modules (/admin/build/modules).

5) Go to Site configuration > Postmark (/admin/settings/postmark)
   
6) Enable Postmark functionality and add your API key from your Postmark account.

7) The test functionality enables you to test the integration is working, this 
   will use a credit by default each time you submit an email address.

8) The email address that emails are sent from on your site must have a valid 
   Sender Signature set up in your Postmark account. Different modules use 
   different settings for the "From" address. One important place to check is 
   the address on Administer > Site configuration > Site information.

Support and bugs
----------------

If you have any problems using the module, please submit an issue in the 
Postmark queue (http://drupal.org/project/issues/postmark).

That's also a good place to check for known problems and "todos".

Credit
------

The Postmark module was developed by
 * Luke Simmons (luketsimmons)
 * Allister Price (alli.price)
from Deeson Online (http://www.deeson.co.uk/online).

Credit also goes to the phpmailer (http://drupal.org/project/phpmailer) module on 
which this module is heavily based.

File

README.txt
View source 
  1. Module description

  2. ------------------

  3. 

  4. The Postmark module allows the administrator to switch the standard SMTP 

  5. library over to use the third party Postmark library. An account with 

  6. Postmark is required to use this module.

  7. 

  8. The recommended third party library for this module is the latest version

  9. of the Postmark PHP class v0.4.4 by Markus Hedlund et al.

  10. http://github.com/Znarkus/postmark-php

  11. 

  12. Note: The module uses the REST API to connect to Postmark.

  13. 

  14. Installation

  15. ------------

  16. 

  17. Installing the Postmark module requires a few steps :

  18. 

  19. 1) Copy the postmark folder to the modules folder in your installation 

  20.    This is usually sites/all/modules.

  21. 

  22. 2) Obtain the Postmark PHP library from http://github.com/Znarkus/postmark-php.

  23. 

  24. 3) Copy the files to the includes directory in the module folder

  25.    /modules/postmark/includes.

  26. 

  27. 4) You must ensure you get the Certificate folder too as this is now implemented

  28.    within the PHP class.

  29. 

  30. 4) Enable the module using Administer > Modules (/admin/build/modules).

  31. 

  32. 5) Go to Site configuration > Postmark (/admin/settings/postmark)

  33.    

  34. 6) Enable Postmark functionality and add your API key from your Postmark account.

  35. 

  36. 7) The test functionality enables you to test the integration is working, this 

  37.    will use a credit by default each time you submit an email address.

  38. 

  39. 8) The email address that emails are sent from on your site must have a valid 

  40.    Sender Signature set up in your Postmark account. Different modules use 

  41.    different settings for the "From" address. One important place to check is 

  42.    the address on Administer > Site configuration > Site information.

  43. 

  44. Support and bugs

  45. ----------------

  46. 

  47. If you have any problems using the module, please submit an issue in the 

  48. Postmark queue (http://drupal.org/project/issues/postmark).

  49. 

  50. That's also a good place to check for known problems and "todos".

  51. 

  52. Credit

  53. ------

  54. 

  55. The Postmark module was developed by

  56.  * Luke Simmons (luketsimmons)

  57.  * Allister Price (alli.price)

  58. from Deeson Online (http://www.deeson.co.uk/online).

  59. 

  60. Credit also goes to the phpmailer (http://drupal.org/project/phpmailer) module on 

  61. which this module is heavily based.