PHP Класс Spatie\Newsletter\Newsletter

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$lists	NewsletterListCollection	* @var \Spatie\Newsletter\NewsletterListCollection
$mailChimp	DrewM\MailChimp\MailChimp

Открытые методы

Метод	Описание
__construct ( MailChimp $mailChimp, NewsletterListCollection $lists )
createCampaign ( string $fromName, string $replyTo, string $subject, string $html = '', string $listName = '', array $options = [], array $contentOptions = [] ) : array \| boolean
delete ( $email, string $listName = '' ) : array \| false
getApi ( ) : MailChimp
getLastError ( ) : array \| false
getMember ( string $email, string $listName = '' ) : array \| boolean
hasMember ( string $email, string $listName = '' ) : boolean
lastActionSucceeded ( ) : boolean
subscribe ( string $email, array $mergeFields = [], string $listName = '', array $options = [] ) : array \| boolean
subscribeOrUpdate ( string $email, array $mergeFields = [], string $listName = '', array $options = [] ) : array \| boolean
unsubscribe ( $email, string $listName = '' ) : array \| false
updateContent ( $campaignId, $html, $options = [] )

Защищенные методы

Метод	Описание
getSubscriberHash ( string $email ) : string
getSubscriptionOptions ( $email, $mergeFields, $options ) : array

Описание методов

__construct() публичный Метод

public __construct ( MailChimp $mailChimp, NewsletterListCollection $lists )
$mailChimp	DrewM\MailChimp\MailChimp
$lists	NewsletterListCollection

createCampaign() публичный Метод

public createCampaign ( string $fromName, string $replyTo, string $subject, string $html = '', string $listName = '', array $options = [], array $contentOptions = [] ) : array \| boolean
$fromName	string
$replyTo	string
$subject	string
$html	string
$listName	string
$options	array
$contentOptions	array
Результат	array \| boolean

delete() публичный Метод

public delete ( $email, string $listName = '' ) : array \| false
$email
$listName	string
Результат	array \| false

getApi() публичный Метод

public getApi ( ) : MailChimp
Результат	DrewM\MailChimp\MailChimp

getLastError() публичный Метод

public getLastError ( ) : array \| false
Результат	array \| false

getMember() публичный Метод

public getMember ( string $email, string $listName = '' ) : array \| boolean
$email	string
$listName	string
Результат	array \| boolean

getSubscriberHash() защищенный Метод

protected getSubscriberHash ( string $email ) : string
$email	string
Результат	string

getSubscriptionOptions() защищенный Метод

protected getSubscriptionOptions ( $email, $mergeFields, $options ) : array
$email
$mergeFields
$options
Результат	array

hasMember() публичный Метод

public hasMember ( string $email, string $listName = '' ) : boolean
$email	string
$listName	string
Результат	boolean

lastActionSucceeded() публичный Метод

public lastActionSucceeded ( ) : boolean
Результат	boolean

subscribeOrUpdate() публичный Метод

public subscribeOrUpdate ( string $email, array $mergeFields = [], string $listName = '', array $options = [] ) : array \| boolean
$email	string
$mergeFields	array
$listName	string
$options	array
Результат	array \| boolean

unsubscribe() публичный Метод

public unsubscribe ( $email, string $listName = '' ) : array \| false
$email
$listName	string
Результат	array \| false

updateContent() публичный Метод

public updateContent ( $campaignId, $html, $options = [] )

Описание свойств

$lists защищенное свойство

* @var \Spatie\Newsletter\NewsletterListCollection

protected NewsletterListCollection,Spatie\Newsletter $lists
Результат	NewsletterListCollection

$mailChimp защищенное свойство

protected MailChimp,DrewM\MailChimp $mailChimp
Результат	DrewM\MailChimp\MailChimp