Some emails are configured using the gb_template_recipients table to allow more flexibility in defining who will receive the email.

For example, emails triggered by the Contracts / Payout process.

Some emails contain a coded recipient, but you are able to add extra recipients to the email by adding records here.

For example, the Driver Reports and the FBT declaration and advice emails under Standard Reports are hard coded to be sent to the driver's email address, but you can add extra recipients here.

Email attachments are sent to all recipients regardless of origin (i.e. coded or stored in gb_template_recipients) or type (i.e. To, CC or BCC).

Initially, you will need to provide Catch-e the following details:

  • What templates you would like to have this set up for

  • What email address is to be used

  • What field you would like to recipient's address to be stored against, i.e: 'to', 'cc' and 'bcc'

"Recipient" can be an individual's email address or that of a department or group.

Field Descriptions

Field

Type

Description

template_recipient_id

ID

System generated. Upload "0"

template_id

ID

ID of parent gb_template record

name_from_field

text

This is a field name from the underlying report linking to this template. If set, and the report field actually exists,

[gb_mail_recipients]name will be populated from that report field.

Note: leave this field blank if you are using name.

[See Example 1]

address_from_field

text

Like name_from_field, this is used to populate [gb_mail_recipients]address from a field in the underlying report.

name

text

This value will directly populate [gb_mail_recipients]name.

Note: name_from_field must be blank.

[See Example 2]

address

ID

This is used in the same way as name to populate [gb_mail_recipients]address

type

text

One of the following values 'to', 'cc', or 'bcc'. If you use 'to', then you MUST use name_from_field and address_from_field.

receipt_flag

text

To request and acknowledgement of receipt set this to 'yes', otherwise set to 'no'.

status_flag

text

Set to 'active'. If 'inactive' this recipient record will be ignored.