Installation and configuration

Last updated on
30 April 2025

After downloading and unpacking the package into your modules folder:

  • Enable the Messaging Framework module and the ones for the sending methods you are going to use (Mail, SMS, Web...)
  • There are some sending methods ready to use like Mail or Simple. Other methods (SMS, PHPMailer...) depend on other modules that need to be set up first.
  • You need to enable at least one sending method to get started. Other's can be installed and enabled later.

This messaging system relies on the Filters and Input Formats for adequate message filtering and formatting. These filters are applied to outgoing messages and are important for security and formatting. They'll depend on your input data and the format used for delivery (May be plain text, HTML or others). So you need to create some Input filters before setting up Messaging

The messaging input format is only meant to be used where the output will be sent to a text based context (i.e. sms or e-mail) and not an HTML context (i.e. browser). So, this input format should not be available to any roles on a site.

To create Input formats for filtering go to Administer > Site configuration > Input formats and click on Add input format.

  • For a method sending out plain text (Like SMS or simple Mail) you'll need to create a Plain text message format. This one will possibly use the Plain text filter provided by the Messaging module itself.
  • For a method sending HTML (Like PHPMailer) you'll need a HTML message format. This one may use the HTML filter, Line break converter and URL filter filters.

Make sure the filtering makes sense for which you'll need to understand how filters work.

  • If you use the 'Line break converter' (which wraps paragraphs with html tags) this one must be before any 'Plain text' converter.
  • If you use the Plain text filter, you do not need the URL Filter.

Go to Administer > Site configuration > Messaging > Settings and on that page:

  • Set the Default send method selecting one of the sending methods you have enabled.
  • Set the appropriate filters for each method. The Input formats you've created before will be available here.

Now you have set up Messaging to be used by other modules, like Notifications. Once you've properly set up that other modules you may need to go to the next section to set up your Message templates

Help improve this page

Page status: Not set

You can: