You are here

README.txt in Campaign Monitor 7

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6.3 README.txt
  4. 6 README.txt
  5. 6.2 README.txt
================
Campaign Monitor
================

----------------
Description
----------------
This module integrates the mailing list service Campaign Monitor.
http://www.campaignmonitor.com

Campaign Monitor is a mailing list and newsletter service useful for web and
design professionals to manage newsletters and campaigns for your clients. The
client can then login through a reports interface to view the detailed reports
of their campaign.

TO USE THIS MODULE YOU MUST HAVE AN ACCOUNT WITH CAMPAIGNMONITOR.COM

This module adds a block that allows people to subscribe to a Campaign Monitor
list through the API. It also adds a page that lists past campaigns.

This module was developed by T-Rex Art: http://www.trexart.com.au

------------
Installation
------------
- At this time the module uses the built in libraries of PHP5 for the SOAP calls
  so it is not available for use with PHP4. If you find there are errors, make
  sure that your PHP installation has SOAP enabled.

- Create a folder in your modules directory called campaignmonitor and put the
  module's files in this directory.

- Create a folder in your sites/all/libraries directory called campaignmonitor and put the
  contents of createsend-php API files from github.com in this directory. It can be download from
  http://github.com/campaignmonitor/createsend-php or use the command below.

  ~$ git clone https://github.com/campaignmonitor/createsend-php.git campaignmonitor
  ~$ cd campaignmonitor
  ~$ git checkout 1.0.11

- Enable the module on the Modules administration page: /admin/modules

- Configure the module at: /admin/config/services/campaignmonitor

------------
Requirements
------------
This module uses the Libraries module to detect the Campaign Monitor API
library. It also uses the default "thumbnail" image style to generate image
previews in the administration interface, so changing this image style will
affect the administration interface.

Ref. http://www.drupal.org/project/libraries

-------------
Configuration
-------------
Make sure to have your API Key and Client ID.
To retrieve these values follow the instructions here:
http://www.campaignmonitor.com/api/required.aspx

This module has been updated to work with the new combined Campaign Monitor and
MailBuild service, so please make sure you have updated your API keys if needed.

Enter these into the module's settings page. You will then be able to choose if
you wish all lists to be available on the site, or if you want to just select
certain lists to display on the site.

It is encouraged for you to spend some time setting up your Campaign Monitor
account before diving in with this module.

NOTE: There is a setting for each list in Campaign Monitor where if you
un-subscribe from one list, you are un-subscribed from all lists. The default
for this is to un-subscribe from all. This makes it so if in the 'My Newsletters'
area, a user un-subscribes from one list, they will be un-subscribed from all.
I recommend turning off this feature in the Campaign Monitor administration.

File

README.txt
View source
  1. ================
  2. Campaign Monitor
  3. ================
  4. ----------------
  5. Description
  6. ----------------
  7. This module integrates the mailing list service Campaign Monitor.
  8. http://www.campaignmonitor.com
  9. Campaign Monitor is a mailing list and newsletter service useful for web and
  10. design professionals to manage newsletters and campaigns for your clients. The
  11. client can then login through a reports interface to view the detailed reports
  12. of their campaign.
  13. TO USE THIS MODULE YOU MUST HAVE AN ACCOUNT WITH CAMPAIGNMONITOR.COM
  14. This module adds a block that allows people to subscribe to a Campaign Monitor
  15. list through the API. It also adds a page that lists past campaigns.
  16. This module was developed by T-Rex Art: http://www.trexart.com.au
  17. ------------
  18. Installation
  19. ------------
  20. - At this time the module uses the built in libraries of PHP5 for the SOAP calls
  21. so it is not available for use with PHP4. If you find there are errors, make
  22. sure that your PHP installation has SOAP enabled.
  23. - Create a folder in your modules directory called campaignmonitor and put the
  24. module's files in this directory.
  25. - Create a folder in your sites/all/libraries directory called campaignmonitor and put the
  26. contents of createsend-php API files from github.com in this directory. It can be download from
  27. http://github.com/campaignmonitor/createsend-php or use the command below.
  28. ~$ git clone https://github.com/campaignmonitor/createsend-php.git campaignmonitor
  29. ~$ cd campaignmonitor
  30. ~$ git checkout 1.0.11
  31. - Enable the module on the Modules administration page: /admin/modules
  32. - Configure the module at: /admin/config/services/campaignmonitor
  33. ------------
  34. Requirements
  35. ------------
  36. This module uses the Libraries module to detect the Campaign Monitor API
  37. library. It also uses the default "thumbnail" image style to generate image
  38. previews in the administration interface, so changing this image style will
  39. affect the administration interface.
  40. Ref. http://www.drupal.org/project/libraries
  41. -------------
  42. Configuration
  43. -------------
  44. Make sure to have your API Key and Client ID.
  45. To retrieve these values follow the instructions here:
  46. http://www.campaignmonitor.com/api/required.aspx
  47. This module has been updated to work with the new combined Campaign Monitor and
  48. MailBuild service, so please make sure you have updated your API keys if needed.
  49. Enter these into the module's settings page. You will then be able to choose if
  50. you wish all lists to be available on the site, or if you want to just select
  51. certain lists to display on the site.
  52. It is encouraged for you to spend some time setting up your Campaign Monitor
  53. account before diving in with this module.
  54. NOTE: There is a setting for each list in Campaign Monitor where if you
  55. un-subscribe from one list, you are un-subscribed from all lists. The default
  56. for this is to un-subscribe from all. This makes it so if in the 'My Newsletters'
  57. area, a user un-subscribes from one list, they will be un-subscribed from all.
  58. I recommend turning off this feature in the Campaign Monitor administration.