Communication Entry
Allows you to send out Email/SMS communications to a group of recipients.
This block is relatively simple to use, but it requires a decent understanding of Communications in Rock.
Setup
For this block to work correctly, you must pass in a valid EntitySetGuid
page parameter. This will populate the list of recipients that receive the communication. The EntitySetType should be of Person.
You can generate these EntitySetGuid parameters auto-magically, using the Group Member List block.
Settings
Setting | Description |
---|---|
Enable Email | Enable 'Email' as a communication transport. |
Enable SMS | Enable 'SMS' as a communication transport. |
Show From Name | Show the 'From Name' field for the email communication transport. |
Show Reply To | Show the 'Reply To' field for the email communication transport. |
Show Parent Communication Toggle | Show the toggle that enables/disables parent communication. You can use this in accordance with the 'ForceSendToParents' parameter. |
Is Bulk | Whether or not the communication should be flagged as bulk. |
Allowed SMS Numbers | The system phone numbers that are available to use as the 'From Number' for SMS communication. If none are supplied, all of the numbers in the list are available. |
Show Only Personal SMS Number | Only SMS numbers tied to the current individual will be shown. Those with ADMIN rights will see all SMS numbers. |
Hide Personal SMS Number | Only SMS numbers that are not tied to an individual will be shown. |
Person Profile Page | This page is navigated to from the list of recipients that the communication failed to send to. The page is pushed to with a |
SMS Character Limit | The amount of characters to limit an SMS message to. |
Show Additional Email Recipients | Whether or not the field should be enabled to show additional email recipients. |
Page Parameters
This block supports many query strings that can be used to override the block settings. This allows you to set a default, then customize the experience for each individual based on something like the group role or other data from Rock.
Name | Type | Description |
---|---|---|
EntitySetGuid | Guid | The EntitySet that sets the recipients for the communication. |
EnableSms | bool | Takes precedence over the 'Enable Sms' block setting. Use this to enable/disable the sending of an SMS communication. |
EnableEmail | bool | Takes precedence over the 'Enable Email' block setting. Use this to enable/disable the sending of an Email communication. |
FromEmail | string | The email to send the communication from. If none are supplied, the block will assume the email of the current person. |
FromNumberGuid | Guid | The Guid of the System Phone Number to set this block to use. Note, that this number must be available to the block. You can see more information in the configuring phone numbers section. |
MaxRecipients | int | This doesn't limit the number of email recipients but is the maximum number before approval is required. The confirmation message on the final page will change to say the message has been submitted for approval. |
ForceSendToParents | bool | If parent communication is enabled, this will force any communication to also be sent to the parents of any children in the recipients. |
ShowFromName | bool | Whether or not to show the 'From Name' Email field. |
ShowReplyTo | bool | Whether or not to show the 'Reply To' Email field. |
IsBulk | bool | Takes precedence over the 'Is Bulk' block setting. Whether or not to set the communication as bulk or not. |
ReplyTo | string | When provided (and Show Reply To is enabled), the "Reply To" value for an Email communication will be hard-coded to the provide value. |
FromNumberGuid | Guid | The Guid of the system phone number to limit the SMS communication to (From Number). Note that this number must be available to the block. |
Security (Approving Communications)
This block uses a unique security verb, named Approve
. This security role determines if someone is allowed to instantly queue a communication, or if it must be submitted for approval beforehand. It is highly recommended to configure the security on this block, to ensure not anyone can send a communication to a large number of people.
Here is the security action configured to behave exactly the same as the web block:
Last updated