Overview

Classes

  • Quform
  • Quform_Admin_InsertForm
  • Quform_Admin_Page
  • Quform_Admin_Page_Controller
  • Quform_Admin_Page_Dashboard
  • Quform_Admin_Page_Entries
  • Quform_Admin_Page_Entries_Edit
  • Quform_Admin_Page_Entries_List
  • Quform_Admin_Page_Entries_View
  • Quform_Admin_Page_Factory
  • Quform_Admin_Page_Forms_Add
  • Quform_Admin_Page_Forms_Edit
  • Quform_Admin_Page_Forms_List
  • Quform_Admin_Page_Help
  • Quform_Admin_Page_Preview
  • Quform_Admin_Page_Settings
  • Quform_Admin_Page_Tools
  • Quform_Admin_Page_Tools_ExportEntries
  • Quform_Admin_Page_Tools_ExportForm
  • Quform_Admin_Page_Tools_Home
  • Quform_Admin_Page_Tools_ImportForm
  • Quform_Admin_Page_Tools_Migrate
  • Quform_Admin_Page_Tools_Uninstall
  • Quform_Api
  • Quform_Block
  • Quform_Builder
  • Quform_Captcha
  • Quform_ClassLoader
  • Quform_Confirmation
  • Quform_Container
  • Quform_Dashboard_Widget
  • Quform_Dispatcher
  • Quform_Element
  • Quform_Element_Captcha
  • Quform_Element_Checkbox
  • Quform_Element_Column
  • Quform_Element_Container
  • Quform_Element_Container_Iterator
  • Quform_Element_Date
  • Quform_Element_Email
  • Quform_Element_Factory
  • Quform_Element_Field
  • Quform_Element_File
  • Quform_Element_Group
  • Quform_Element_Hidden
  • Quform_Element_Honeypot
  • Quform_Element_Html
  • Quform_Element_Multi
  • Quform_Element_Multiselect
  • Quform_Element_Name
  • Quform_Element_Page
  • Quform_Element_Password
  • Quform_Element_Radio
  • Quform_Element_Recaptcha
  • Quform_Element_Row
  • Quform_Element_Select
  • Quform_Element_Submit
  • Quform_Element_Text
  • Quform_Element_Textarea
  • Quform_Element_Time
  • Quform_Entry_Controller
  • Quform_Entry_Exporter
  • Quform_Entry_List_Settings
  • Quform_Entry_List_Table
  • Quform_Entry_Processor
  • Quform_Entry_UserSearcher
  • Quform_Filter_Abstract
  • Quform_Filter_Alpha
  • Quform_Filter_AlphaNumeric
  • Quform_Filter_Digits
  • Quform_Filter_Regex
  • Quform_Filter_Static
  • Quform_Filter_StripTags
  • Quform_Filter_Trim
  • Quform_Form
  • Quform_Form_Controller
  • Quform_Form_Exporter
  • Quform_Form_Factory
  • Quform_Form_Importer
  • Quform_Form_Iterator
  • Quform_Form_List_Settings
  • Quform_Form_List_Table
  • Quform_Form_Processor
  • Quform_License
  • Quform_Migrator
  • Quform_NonceRefresher
  • Quform_Notification
  • Quform_Notification_Resender
  • Quform_Options
  • Quform_Permissions
  • Quform_Repository
  • Quform_ScriptLoader
  • Quform_Session
  • Quform_Settings
  • Quform_Shortcode
  • Quform_Themes
  • Quform_TokenReplacer
  • Quform_Toolbar
  • Quform_Translations
  • Quform_Updater
  • Quform_Upgrader
  • Quform_Uploader
  • Quform_Validator_Abstract
  • Quform_Validator_Alpha
  • Quform_Validator_AlphaNumeric
  • Quform_Validator_Array
  • Quform_Validator_Captcha
  • Quform_Validator_Date
  • Quform_Validator_Digits
  • Quform_Validator_Duplicate
  • Quform_Validator_Email
  • Quform_Validator_FileUpload
  • Quform_Validator_GreaterThan
  • Quform_Validator_Honeypot
  • Quform_Validator_Identical
  • Quform_Validator_InArray
  • Quform_Validator_Length
  • Quform_Validator_LessThan
  • Quform_Validator_Recaptcha
  • Quform_Validator_Regex
  • Quform_Validator_Required
  • Quform_Validator_Static
  • Quform_Validator_Time
  • Quform_View
  • Quform_ViewFactory
  • Quform_Widget_Form
  • Quform_Widget_Popup

Interfaces

  • Quform_Attachable
  • Quform_Element_Editable
  • Quform_Filter_Interface
  • Quform_Validator_Interface
  • Overview
  • Class

Class Quform_Notification

Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Notification.php
Methods summary
public
# __construct( array $config, Quform_Form $form, Quform_Options $options )

Parameters

$config
$form
$options
public
# send( )

Send the notification

Send the notification

protected array
# replaceVariables( array $recipient )

Replace variable tokens within the recipient fields.

Replace variable tokens within the recipient fields.

Parameters

$recipient

Returns

array
public mixed
# config( string $key, null $default = null )

Returns the config value for the given $key

Returns the config value for the given $key

Parameters

$key
$default

Returns

mixed
The config value or $default if not set
public
# setConfig( string|array $key, mixed $value = null )

Set the config value for the given $key or multiple values using an array

Set the config value for the given $key or multiple values using an array

Parameters

$key
Key or array of key/values
$value
Value or null if $key is array

Returns


$this
public array|false
# getMailerConfig( )

Get the parameters to pass to the mail function

Get the parameters to pass to the mail function

Returns

array|false
The mailer config array or false if this notification should not be sent
public boolean
# isRtl( )

Is this notification RTL?

Is this notification RTL?

Returns

boolean
public
# processHooks( PHPMailer\PHPMailer\PHPMailer|PHPMailer $mailer )

Run hooks before the email is sent

Run hooks before the email is sent

Parameters

$mailer
protected string
# formatRecipient( array $recipient )

Format the given recipient for an email header

Format the given recipient for an email header

Parameters

$recipient

Returns

string
protected string
# wrapHtmlMessage( string $message )

Wraps the given message in outer HTML tags

Wraps the given message in outer HTML tags

Parameters

$message

Returns

string
public string
# getIdentifier( )

Get the notification unique ID

Get the notification unique ID

Returns

string
public static
# addAltBody( PHPMailer\PHPMailer\PHPMailer|PHPMailer $mailer, Quform_Notification $notification, Quform_Form $form )

Add the AltBody to multipart email notifications

Add the AltBody to multipart email notifications

Currently, this needs to be done with a hook as wp_mail() does not support multipart messages

Parameters

$mailer
The PHPMailer instance
$notification
The notification instance
$form
The form instance
public static array
# getDefaultConfig( string|null $key = null )

Get the default notification configuration

Get the default notification configuration

Parameters

$key
Get the config by key, if omitted the full config is returned

Returns

array
Properties summary
protected array $config
# array()
protected Quform_Form $form
#
protected Quform_Options $options
#
API documentation generated by ApiGen