Skip to main content

Communication

Alerts

To add an alert, go to ACP > Monetize > Communication > Manage alerts and click Add alert.

General Options:

Send on day(s) - Alerts can be set to be sent on specific days of the month or specific days of the week. The minimum period between alerts is therefore 1 day and the maximum period between alerts is 1 month.

Per user limit - Enter the maximum number of this alert a user can receive and the length of time they should only receive that number. The length of time must be less than the log retention period or the total alerts per user limit. To allow unlimited alerts, set the fields to 0.

Title - Enter a name for the alert. This is not visible to the user.

From user - Enter the name of the user you would like this alert to appear from or leave it blank for the alert to be sent anonymously.

Link URL/Link title - If you would like to include a main link in the alert, enter the URL in the Link URL box and a name for it in the Link title box. Then you can either insert it in the alert body with {link} or it will be appended at the end of the alert automatically.

Alert body - This is the main body of your alert. You may use HTML. The following placeholders will be replaced in the message: {name}, {id}, {link}, {phrase:phrase_title}. When entered in the message:

  • The {name} placeholder will insert the name of the recipient.
  • The {id} placeholder will insert the user ID of the recipient.
  • The {link} placeholder will insert the link entered above.
  • The {phrase:phrase_title} placeholder will replace with the named phrase in the language of the recipient.

Active - Check this box for the alert to be enabled. Each alert can be individually enabled or disabled.

User Upgrade Criteria:

The following user upgrade criteria can be set:

  • User upgrade status - This allows you to select only upgrades that are active or expired. If a user has had the same user upgrade multiple times, it may be possible for an upgrade to be active and expired at the same time, so you can also select NOT active if you specifically want users who do not currently have this upgrade active, or NOT expired if you specifically want users who have never allowed this upgrade to expire.
  • User upgrade details - This allows you to specify whether user upgrades are recurring. For example, if a user has a recurring upgrade, it is not always necessary to let them know if their upgrade is about to expire as it will automatically recur prior to expiration.
  • User upgrade end date - This allows you to specify whether the start date or end date is or isn’t within a certain number of dates.
  • Specific user upgrades - This allows you to specify or exclude particular user upgrades.

Other Criteria:

You can use the User criteria, User field criteria, and Remote platform criteria to set who will receive the alert. If you don’t set any criteria, your alert will be sent to all members. The Remote platform criteria comes from the platforms you have set up using XLink. If you don’t have XLink or any platforms set up, this will not be an option.

Once an alert has been created, it will show on the Alerts list and will indicate the next time an alert will be sent. You can send the alert immediately by clicking the ‘Send now’ button. You can also delete or toggle whether the alert is active from the Alerts list.

Emails

To add an email, go to ACP > Monetize > Communication > Manage emails and click Add email.

General Options:

Send on day(s) - Emails can be set to be sent on specific days of the month or specific days of the week. The minimum period between emails is therefore 1 day and the maximum period between emails is 1 month.

Per user limit - Enter the maximum number of this email a user can receive and the length of time they should only receive that number. The length of time must be less than the log retention period or the total emails per user limit. To allow unlimited emails, set the fields to 0.

From name - This is the name that the email will be sent from.

From email - This is the email address that the email will be sent from.

Email title - This is the subject of the email and will be visible by the email recipient.

Email format - You can send your email as Plain text or HTML. Note that email clients handle HTML in widely varying ways. Be sure to test before sending HTML emails. A text version of your email will be generated by removing all HTML tags.

Email body - This is the main body of your email. The following placeholders will be replaced in the message: {name}, {email}, {id}, {unsub}, {phrase:phrase_title}. When entered in the message:

  • The {name} placeholder will insert the name of the recipient.
  • The {id} placeholder will insert the user ID of the recipient.
  • The {email} placeholder will insert the email address of the recipient.
  • The {unsub} will add an unsubscribe link.
  • The {phrase:phrase_title} placeholder will replace with the named phrase in the language of the recipient.

Active - Check this box for the email to be enabled. Each email can be individually enabled or disabled.

Include default email wrapper - If selected, your email content will be wrapped in the standard header and footer used in emails sent elsewhere in XenForo that is configured in style properties.

Automatically include an unsubscribe link - If selected, this email will automatically have an unsubscribe line with a link added at the bottom. If you use the 'unsub' token in the body, this option will be ignored.

Only send to users opting to receive news and update emails - Disabling this option is not recommended as this may result in emails being sent to users who have not opted in or who have opted out of receiving emails, which may be against the law in some countries.

User Upgrade Criteria:

The following user upgrade criteria can be set:

  • User upgrade status - This allows you to select only upgrades that are active or expired. If a user has had the same user upgrade multiple times, it may be possible for an upgrade to be active and expired at the same time, so you can also select NOT active if you specifically want users who do not currently have this upgrade active, or NOT expired if you specifically want users who have never allowed this upgrade to expire.
  • User upgrade details - This allows you to specify whether user upgrades are recurring. For example, if a user has a recurring upgrade, it is not always necessary to let them know if their upgrade is about to expire as it will automatically recur prior to expiration.
  • User upgrade end date - This allows you to specify whether the start date or end date is or isn’t within a certain number of dates.
  • Specific user upgrades - This allows you to specify or exclude particular user upgrades.

Other Criteria:

You can use the User criteria, User field criteria, and Remote platform criteria to set who will receive the email. If you don’t set any criteria, your email will be sent to all members. The Remote platform criteria comes from the platforms you have set up using XLink. If you don’t have XLink or any platforms set up, this will not be an option.

Once an email has been created, it will show on the Emails list and will indicate the next time an email will be sent. You can send the email immediately by clicking the ‘Send now’ button. You can also delete or toggle whether the alert is active from the Emails list.

Messages

To add a message, go to ACP > Monetize > Communication > Manage messages and click Add message.

General Options:

Send on day(s) - Messages can be set to be sent on specific days of the month or specific days of the week. The minimum period between alerts is therefore 1 day and the maximum period between alerts is 1 month.

Per user limit - Enter the maximum number of this message a user can receive and the length of time they should only receive that number. The length of time must be less than the log retention period or the total messages per user limit. To allow unlimited messages, set the fields to 0.

From user - Enter the name of an existing user the conversation should be started by. Note: You cannot start a conversation with yourself. It is not possible to send conversations anonymously.

Conversation title - This is the title of the conversation that will be visible to the recipient user.

Conversation message - This is the main body of your message. You may use BB code. The following placeholders will be replaced in the message: {name}, {id}, {email}, {phrase:phrase_title}. When entered in the message:

  • The {name} placeholder will insert the name of the recipient.
  • The {id} placeholder will insert the user ID of the recipient.
  • The {email} placeholder will insert the email address of the recipient.
  • The {phrase:phrase_title} placeholder will replace with the named phrase in the language of the recipient.

Active - Check this box for the message to be enabled. Each message can be individually enabled or disabled.

Allow anyone in the conversation to invite others - This will allow the recipient to invite other users into the conversation.

Lock conversation - This will stop the recipient from being able to respond to the conversation.

Future message handling - There are 3 options available:

  • Do not leave conversation
  • Leave conversation and accept future messages
  • Leave conversation and ignore future messages

User Upgrade Criteria:

The following user upgrade criteria can be set:

  • User upgrade status - This allows you to select only upgrades that are active or expired. If a user has had the same user upgrade multiple times, it may be possible for an upgrade to be active and expired at the same time, so you can also select NOT active if you specifically want users who do not currently have this upgrade active, or NOT expired if you specifically want users who have never allowed this upgrade to expire.
  • User upgrade details - This allows you to specify whether user upgrades are recurring. For example, if a user has a recurring upgrade, it is not always necessary to let them know if their upgrade is about to expire as it will automatically recur prior to expiration.
  • User upgrade end date - This allows you to specify whether the start date or end date is or isn’t within a certain number of dates.
  • Specific user upgrades - This allows you to specify or exclude particular user upgrades.

Other Criteria:

You can use the User criteria, User field criteria, and Remote platform criteria to set who will receive the message. If you don’t set any criteria, your message will be sent to all members. The Remote platform criteria comes from the platforms you have set up using XLink. If you don’t have XLink or any platforms set up, this will not be an option.

Once a message has been created, it will show on the Messages list and will indicate the next time a message will be sent. You can send the message immediately by clicking the ‘Send now’ button. You can also delete or toggle whether the message is active from the Messages list.