Overview

Packages

  • ACF
  • Automation
    • Actions
    • Activation
    • LeadProfile
    • Menus
    • Queries
    • Rules
    • Triggers
  • CTA
    • Activation
    • AJAXListeners
    • Cloning
    • Core
    • Display
    • EditPage
    • Enqueues
    • GPLSettings
    • LeadsProfile
    • Loading
    • Menus
    • Notices
    • PlacementMetabox
    • PostType
    • Templates
    • Tracking
    • Variations
    • YOAST
  • InboundPro
    • Activation
    • AdminAJAX
    • AutoLoading
    • Cron
    • DataInterface
    • FieldMapping
    • Funnels
    • InboundNowAPI
    • Installer
    • LeadStatuses
    • Menus
    • Notifications
    • Ouath
    • Reports
    • Settings
    • Tracking
    • Translations
    • Updates
  • LandingPages
    • Activation
    • DataInterfaces
    • Management
    • Menus
    • NeedsAttention
    • Notices
    • Sidebars
    • Templates
    • Tracking
    • Variations
    • WelcomeScreen
    • Widgets
  • Leads
    • Activation
    • Akismet
    • BranchControl
    • BulkActions
    • Dashboard
    • Management
    • Notifications
    • Settings
    • Tracking
    • UserProfile
    • WPLogin
  • Mailer
    • Activation
    • Admin
    • ClickTracking
    • DataInterface
    • InboundForms
    • Leads
    • Management
    • Notifications
    • Scheduling
    • Sending
    • Settings
    • ShortcodesAndTokens
    • SparkPost
    • Templates
    • Unsubscribes
    • Variations
    • YoastSEO
  • None
  • Shared
    • APIs
    • CPT
    • DatabaseRoutines
    • DebugTricks
    • DoubleOptin
    • EventManagement
    • FieldMapping
    • InboundForms
    • LeadSorage
    • MarketingButton
    • Menus
    • Notifications
    • Shortcodes
    • ShortcodesAndTokens
    • StandAloneLicensing
    • Tracking
    • VisualEditor
  • xDepreciated

Classes

  • Inbound_Mailer_Unsubscribe
  • Overview
  • Package
  • Class

Class Inbound_Mailer_Unsubscribe

Class for managing Unsubscribe features

Package: Mailer\Unsubscribes
Located at core/mailer/classes/class.unsubscribe.php
Methods summary
public
# __construct( )

Initialize class

Initialize class

public
# load_hooks( )

Loads hooks and filters

Loads hooks and filters

public static
# display_unsubscribe_page( $atts )

Display unsubscribe options

Display unsubscribe options

public static STRING
# generate_unsubscribe_link( ARRAY $params )

Generates unsubscribe link given lead id and lists

Generates unsubscribe link given lead id and lists

Parameters

$params
contains: lead_id (INT ), list_ids (MIXED), email_id (INT)

Returns

STRING
$unsubscribe_link
public static ARRAY
# legacy_decode_unsubscribe_token( STRING $token )

Decodes unsubscribe encoded reader id into a lead id

Decodes unsubscribe encoded reader id into a lead id

Parameters

$token
$reader_id Encoded lead id.

Returns

ARRAY
$unsubscribe array of unsubscribe data
public static
# remove_stop_rule( INT $lead_id, INT $list_id )

Removes a list id to a leads unsubscribed list

Removes a list id to a leads unsubscribed list

Parameters

$lead_id
$list_id
public static
# process_unsubscribe( )

Listener & unsubscribe actions

Listener & unsubscribe actions

public static
# unsubscribe_lead( $params, boolean $all = false )

Parameters

$params
$all
public static
# unsubscribe_from_all_lists( $params )

Unsubscribe lead from all lists

Unsubscribe lead from all lists

public static
# mute_lead_emails( $params, boolean $all, $time )

Parameters

$params
$all
$time
public static
# mute_all_lists( $params, $time )

Unsubscribe lead from all lists

Unsubscribe lead from all lists

public static
# mute_lists( $params, $time )

Unsubscribe lead from all lists

Unsubscribe lead from all lists

public static
# add_stop_rules( INT $lead_id, INT $list_id, $nature = 'unsubscribed' )

Adds a list id to a leads unsubscribed list

Adds a list id to a leads unsubscribed list

Parameters

$lead_id
$list_id
$nature
public static
# get_stop_rules( INT $lead_id, INT $list_id,… )

Adds a list id to a leads unsubscribed list

Adds a list id to a leads unsubscribed list

Parameters

$lead_id
$list_id,…
Inbound Pro Plugin - PHP Codex API documentation generated by ApiGen