ProMailerForms class

Located in file /site/modules/ProMailer/ProMailerForms.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProMailerForms class also inherits all the methods and properties of: ProMailerTypeManager and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
ProMailerForms::checkConfirmEmail()
ProMailerSubscriber bool nullCheck if current request is for a subscribe confirmation and confirm email when applicable
ProMailerForms::getSubscribePage()
Page NullPageGet the ProMailer page that handles subscribe and unsubscribe
ProMailerForms::getSubscribeUrl()
stringGet URL to subscribe to given list
ProMailerForms::getUnsubscribeField(ProMailerList $list)
Field nullGet the Field that has a non-zero value if user is unsubscribed from a pages list
ProMailerForms::getUnsubscribeUrl(ProMailerSubscriber $subscriber)
stringReturn URL to an unsubscribe form
ProMailerForms::install()
(nothing) 
ProMailerForms::processSubscribe($listId, array $options)
arrayProcess subscribe form, called automatically by renderSubscribeForm().
ProMailerForms::renderConfirmEmail($type)
stringFallback method to render confirm email if content not provided to confirm().
ProMailerForms::renderSubscribeForm()
string@param array $options 
ProMailerForms::renderUnsubscribeForm()
string@param array $options 
ProMailerForms::sendConfirmEmail(ProMailerSubscriber $subscriber)
boolSend confirmation email to subscriber
ProMailerForms::subscribe()
stringRender, process and email-confirm a subscription
ProMailerForms::subscribeOptions array 
ProMailerForms::subscribePage Page 
ProMailerForms::subscribeUrl string 
ProMailerForms::table()
stringGet the DB table name used by this type 
ProMailerForms::typeName()
stringGet the class name of the type this class manages 
ProMailerForms::uninstall()
(nothing) 
ProMailerForms::unsubscribe()
stringRender or process an un-subscribe form at URL clicked from an email
ProMailerForms::unsubscribeOptions array 
ProMailerForms::wrapOutput(string $out)
stringWrap given output

Additional methods and properties

In addition to the methods and properties above, ProMailerForms also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer