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.236

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK