TF Mail Documentation

This documentation guides you on how to use TF Mail Joomla extension for Joomla. This extension is used for email marketing and automation with Joomla websites.

1. Users

User Subscribe: Users can be subscribed through Joomla module, menu link or back-end. If user already exists or unsubscribed, the profile of the user is updated. The user will also be subscribed to campaigns (if not already joined).

User Unsubscribe: When a user unsubscribes, the user is marked unsubscribed, any emails in the queue are deleted, and any campaigns user is subscribed to are deleted.

2. Mails (Newsletters)

You can use following tags in the subject:

  • {NAME}
  • {EMAIL}
  • {DATE}

You use following tags in the body of email:

  • {MODIFY}
  • {UNSUB}
  • {USER}
  • {DATE}
  • {TOC}

How to Insert Joomla Article (JA)?

{JA <joomla_article_id> <I or F> <Y or N>}

  • I if for intro text with Read More link; F is for full text
  • Y for adding full text image; N for not adding any image

For example: {JA 26 I Y} will insert intro text of Joomla article with ID 26 with image.

How to Insert User Information?

{USER <field_name>}

For example, {USER name} will insert name of the user. {USER email} will insert email of the user. Similarly, you can use any fields.

3. Queue

When you send any mail or newsletter, it is added in the queue. Click on 'Process Queue' button to send the newsletters to your subscribers. You can automate this using cron job.

You can set the number of emails to send at one time in the configuration.

4. Fields

5. Campaigns

6. Automation

Creates newsletters automatically based on the set frequency. You can insert Joomla articles in the newsletters. Settings are available in the configuration.

Joomla Category: {JC 13 3} - This will insert introduction text of 2 articles from category with ID 13.

7. Distributions

8. Statistics

9. Bounces

10. Configuration

11. Email Sending Process

There are various steps and processes before the extension sends email to the subscribers. You can configure these in the component configuration.

  1. Set from details (name and email) from the component configuration or global configuration
  2. Set reply-to-email and return path from the component configuration
  3. Set recipient email (user or subscriber's email)
  4. Prepare email subject from the saved newsletter subject
    1. Replace formats in the email subject - Name, Email and Date
  5. Prepare email body from the saved newsletter body
    1. Add footer to email body from the configuration
    2. Replace formats in the email body - Unsubscribe Link, Profile Modify Link, Custom Link, User Information, Date, Joomla Articles, table of Contents
    3. Convert Relative URLs to Absolute URLs for anchors and images
    4. Add UTM parameters
    5. Add code to track email opens
    6. Replace texts defined in the configuration
    7. Add html tag
  6. Add attachments to email
  7. Add List-Unsubscribe Header
  8. Set html, encoding, charset
Star InactiveStar InactiveStar InactiveStar InactiveStar Inactive