NewsletterTrait
This is the user subscribe/unsubscribe/checkStatus newsletter trait.
The methods that manage newsletter subscriptions requests to the API will be located here.
Tags
Table of Contents
| newsletterCheckStatus() | Check status user in the newsletter | : NewsletterSubscription|null |
|---|---|---|
| newsletterSubscribe() | Subscribe user to the newsletter | : NewsletterSubscription|null |
| newsletterUnsubscribe() | Unsubscribe user to the newsletter | : NewsletterSubscription|null |
Methods
newsletterCheckStatus()
Check status user in the newsletter
public
newsletterCheckStatus(NewsletterSubscriptionParametersGroup $params) : NewsletterSubscription|null
Parameters
- $params : NewsletterSubscriptionParametersGroup
Return values
NewsletterSubscription|null —newsletterSubscribe()
Subscribe user to the newsletter
public
newsletterSubscribe(NewsletterSubscriptionParametersGroup $params) : NewsletterSubscription|null
Parameters
- $params : NewsletterSubscriptionParametersGroup
Return values
NewsletterSubscription|null —newsletterUnsubscribe()
Unsubscribe user to the newsletter
public
newsletterUnsubscribe(NewsletterSubscriptionParametersGroup $params) : NewsletterSubscription|null
Parameters
- $params : NewsletterSubscriptionParametersGroup