mbr_is_email_unsubscribed
Usage
This shortcode determines the content to be included based upon the ActiveCampaign list's unsubscribed status of the current logged in user.
Parameters
Parameters | Description |
---|---|
list_id | The ActiveCampaign list ID whose status should be evaluated for the current logged in user. The list_id can be determined in ActiveMember360, Utilities, Lists. Default: none. Required: yes. |
Validity
This shortcode is only evaluated for logged in users who also exist as contacts within ActiveCampaign otherwise it is ignored.
Conditional Branching
[ELSE_is_email_unsubscribed] conditional branching is supported.
Nesting
Shortcode nesting within is NOT supported.
Examples
- Example 1
- Example 2
Will display "You are currently unsubscribed from our Advanced list." if the current logged in users status for the ActiveCampaign list with ID 23 is unsubscribed:
[mbr_is_email_unsubscribed list_id='23']
You are currently unsubscribed to our Advanced list.
[/mbr_is_email_unsubscribed]
Will display a HTML link labelled "Click here to subscribe to the XYZ newsletter" if the current logged in users status for the ActiveCampaign list with ID 17 is unsubscribed. When clicked the user will be subscribed to the list. Otherwise a HTML link labelled "Click here to unsubscribe from the XYZ newsletter" will be displayed. When clicked the user will be unsubscribed from the list:
[mbr_is_email_unsubscribed list_id='17']
[mbr_list subscribe='17' link_text='Click here to subscribe to the XYZ newsletter']
[ELSE_is_email_unsubscribed]
[mbr_list unsubscribe='17' link_text='Click here to unsubscribe from the XYZ newsletter']
[/mbr_is_email_unsubscribed]
API
For direct use in PHP code use the conditional function mbr_is_email_unsubscribed($list_id)
in a structure as illustrated here:
$list_id = 5;
IF (mbr_is_email_unsubscribed($list_id)) :
echo 'You have an active email and are confirmed to receive our content mailing.';
ENDIF;