ProMailerSubscribers::add() ProMailerSubscribers::add(string $email, $list) ProMailerSubscribers::add(string $email, $list, bool $confirmed = true, array $data = []) | ProMailerSubscriber bool int | Add a subscriber to a subscribers list | |
ProMailerSubscribers::addReady() ProMailerSubscribers::addReady(string $email, ProMailerList $list, bool $confirmed, array $data) ProMailerSubscribers::addReady(string $email, ProMailerList $list, bool $confirmed, array $data) | bool | Ready to add new subscriber | |
ProMailerSubscribers::added() ProMailerSubscribers::added(ProMailerSubscriber $subscriber) ProMailerSubscribers::added(ProMailerSubscriber $subscriber) | None | New subscriber added | |
ProMailerSubscribers::bounce() ProMailerSubscribers::bounce($subscriber) ProMailerSubscribers::bounce($subscriber, $list = null) | int | Record a bounce for an email address or a subscriber in a list | |
ProMailerSubscribers::confirmEmail() ProMailerSubscribers::confirmEmail(string $email, $list, string $code) ProMailerSubscribers::confirmEmail(string $email, $list, string $code) | bool | Confirm a subscriber as opt-in for a list | |
ProMailerSubscribers::confirmEmailReady() ProMailerSubscribers::confirmEmailReady(string $email, ProMailerList $list, string $code) ProMailerSubscribers::confirmEmailReady(string $email, ProMailerList $list, string $code) | bool | Ready to confirm an email | |
ProMailerSubscribers::confirmedEmail() ProMailerSubscribers::confirmedEmail(string $email, ProMailerList $list, string $code) ProMailerSubscribers::confirmedEmail(string $email, ProMailerList $list, string $code) | None | Email confirmed | |
ProMailerSubscribers::copyAll() ProMailerSubscribers::copyAll(ProMailerList $list1, ProMailerList $list2) ProMailerSubscribers::copyAll(ProMailerList $list1, ProMailerList $list2) | array | Copy all subscribers from list1 into list2 | |
ProMailerSubscribers::count() ProMailerSubscribers::count() ProMailerSubscribers::count(array $options = []) | int | Return total count of subscribers for given list | |
ProMailerSubscribers::exportCSV() ProMailerSubscribers::exportCSV($listId) ProMailerSubscribers::exportCSV($listId) | None | Export subscribers to CSV download | |
ProMailerSubscribers::find() ProMailerSubscribers::find() ProMailerSubscribers::find(array $options = []) | ProMailerSubscribersArray int | Get current pagination (limit=100) of subscribers for given list | |
ProMailerSubscribers::get() ProMailerSubscribers::get($id) ProMailerSubscribers::get($id, $list = 0) | ProMailerSubscriber bool | Get a subscriber by email or ID | |
ProMailerSubscribers::getAllowedSorts() ProMailerSubscribers::getAllowedSorts() ProMailerSubscribers::getAllowedSorts() | array | Get fields allowed for sorting of subscribers | |
ProMailerSubscribers::getByEmail() ProMailerSubscribers::getByEmail(string $email) ProMailerSubscribers::getByEmail(string $email, $list = null, int $limit = 1) | bool array ProMailerSubscriber | Given an email address return the subscriber or boolean false if not found | |
ProMailerSubscribers::getById() ProMailerSubscribers::getById(int $id) ProMailerSubscribers::getById(int $id, $list = 0) | bool ProMailerSubscriber | Get a subscriber by ID | |
ProMailerSubscribers::getCode() ProMailerSubscribers::getCode($subscriber) ProMailerSubscribers::getCode($subscriber, bool $create = false) | string | Get the confirmation code for given subscriber array or Page | |
ProMailerSubscribers::getConfirmUrl() ProMailerSubscribers::getConfirmUrl(ProMailerSubscriber $subscriber) ProMailerSubscribers::getConfirmUrl(ProMailerSubscriber $subscriber, $page = null, $list = null) | string | Get the URL needed to confirm a subscriber | |
ProMailerSubscribers::getDefaultSort() ProMailerSubscribers::getDefaultSort() ProMailerSubscribers::getDefaultSort() | string | Get default sort for subscribers | |
ProMailerSubscribers::getNext() ProMailerSubscribers::getNext($list) ProMailerSubscribers::getNext($list, $lastSubscriberId = 0, bool $confirmed = true, bool $reverse = false) | ProMailerSubscriber bool null | Get the next subscriber for the given list | |
ProMailerSubscribers::getPageEmailField() ProMailerSubscribers::getPageEmailField($list) ProMailerSubscribers::getPageEmailField($list) | string | Get name of field used for email address on subscriber pages | |
ProMailerSubscribers::getPageTemplates() ProMailerSubscribers::getPageTemplates($list) ProMailerSubscribers::getPageTemplates($list) | array | Get array of template names used by subscriber pages | |
ProMailerSubscribers::getUnsubscribeUrl() ProMailerSubscribers::getUnsubscribeUrl($subscriber) ProMailerSubscribers::getUnsubscribeUrl($subscriber) | string | Get the URL to unsubscribe a particular subscriber from their list | |
ProMailerSubscribers::importCSV() ProMailerSubscribers::importCSV(string $csvFile, $list) ProMailerSubscribers::importCSV(string $csvFile, $list, array $options = []) | array bool | Import subscribers from given CSV file | |
ProMailerSubscribers::install() ProMailerSubscribers::install() ProMailerSubscribers::install() | None | | |
ProMailerSubscribers::pageSelector() ProMailerSubscribers::pageSelector($list) ProMailerSubscribers::pageSelector($list, array $options = []) | string array | Return selector for finding subscribers from given list | |
ProMailerSubscribers::pageToSubscriber() ProMailerSubscribers::pageToSubscriber(Page $page, $list) ProMailerSubscribers::pageToSubscriber(Page $page, $list) | ProMailerSubscriber | Convert Page to a subscriber array | |
ProMailerSubscribers::removeUnconfirmed() ProMailerSubscribers::removeUnconfirmed() ProMailerSubscribers::removeUnconfirmed(int $days = 30) | int | Remove subscribers that haven’t been confirmed for given number of days | |
ProMailerSubscribers::save() ProMailerSubscribers::save(ProMailerSubscriber $subscriber) ProMailerSubscribers::save(ProMailerSubscriber $subscriber, $properties = []) | bool | Save/update the given subscriber | |
ProMailerSubscribers::saveLog() ProMailerSubscribers::saveLog(string $str) ProMailerSubscribers::saveLog(string $str) | None | Save entry to subscribers log | |
ProMailerSubscribers::saveLogDisabled() ProMailerSubscribers::saveLogDisabled() ProMailerSubscribers::saveLogDisabled(bool $disabled = null) | bool | Disable or enable logging or return current state if given no argumenets | |
ProMailerSubscribers::saveReady() ProMailerSubscribers::saveReady(ProMailerSubscriber $subscriber, array $properties) ProMailerSubscribers::saveReady(ProMailerSubscriber $subscriber, array $properties) | bool | Subscriber ready to save | |
ProMailerSubscribers::saved() ProMailerSubscribers::saved(ProMailerSubscriber $subscriber, array $properties) ProMailerSubscribers::saved(ProMailerSubscriber $subscriber, array $properties) | None | Subscriber saved | |
ProMailerSubscribers::table() ProMailerSubscribers::table() ProMailerSubscribers::table() | None | | |
ProMailerSubscribers::unsubscribe() ProMailerSubscribers::unsubscribe($subscriber, $list) ProMailerSubscribers::unsubscribe($subscriber, $list, $code = false) | bool | Remove a subscriber from a list | |
ProMailerSubscribers::unsubscribeAllFromList() ProMailerSubscribers::unsubscribeAllFromList(ProMailerList $list) ProMailerSubscribers::unsubscribeAllFromList(ProMailerList $list) | int | Remove all subscribers from a list | |
ProMailerSubscribers::unsubscribed() ProMailerSubscribers::unsubscribed(ProMailerSubscriber $subscriber, ProMailerList $list) ProMailerSubscribers::unsubscribed(ProMailerSubscriber $subscriber, ProMailerList $list) | None | Subscriber removed from list | |
ProMailerSubscribers::unsubscribedEmail() ProMailerSubscribers::unsubscribedEmail(string $email) ProMailerSubscribers::unsubscribedEmail(string $email) | None | Email address removed from ALL lists | |
ProMailerSubscribers::unsubscribedPage() ProMailerSubscribers::unsubscribedPage(Page $subscriber, ProMailerList $list) ProMailerSubscribers::unsubscribedPage(Page $subscriber, ProMailerList $list) | None | Page-based subscriber unsubscribed from pages-type list | |
ProMailerSubscribers::upgrade() ProMailerSubscribers::upgrade($fromVersion, $toVersion) ProMailerSubscribers::upgrade($fromVersion, $toVersion) | None | | |