Newsletter events allow modules to notify listeners i.e. email campaign systems to add or remove subscribers among other functionality.
Add a subscriber to a mailing list.
| Parameter | Description |
|---|---|
| listId | The ID of the list to subscribe the user to. |
| The email address of the user to subscribe. | |
| firstName | The users first name. |
| lastName | The users last name. |
Remove a subscriber from a mailing list.
| Parameter | Description |
|---|---|
| listId | The ID of the list to unsubscribe the user from. |
| The email address of the user to unsubscribe. |
Test if an email address is subscribed to a mailing list.
| Parameter | Description |
|---|---|
| listId | The ID of the list to check for the email address. |
| The email address of the user to check for. | |
| isSubscribed | The event handler should set to true if the user is found otherwise it should be left unchanged. |