FundraiserUnsubscribeSilverpop Class Reference

Handler for unsubscribe links sent by SilverPop - ie the annoying emails we send begging for money at the start of new fundraising campaigns :) More...

Inheritance diagram for FundraiserUnsubscribeSilverpop:

Collaboration diagram for FundraiserUnsubscribeSilverpop:

Public Member Functions
	__construct ()
	processRemoteAction ( $txnName, DOMDocument $dom, XmlTransactionProcessor &$processObj)
	Callback function from doTransaction()
	update ( $requestID, $process, array $params)
	Performs the subscription action.
Public Member Functions inherited from SubscriptionMethod
	getRequiredParameters ()
	Get the URI parameter names required to be passed to update()

Static Public Member Functions
static	decodeEmail (array $params)
	Decodes an email address that has been sent to us from SilverPop.

Private Attributes
string[]	$currentParams = []
string[]	$remoteActionEnvelope = [ 'Envelope', 'Body' ]
array[]	$remoteActionMap

Additional Inherited Members
Protected Member Functions inherited from SubscriptionMethod
	addRequiredParameter ( $name, $regex)
Protected Attributes inherited from SubscriptionMethod
string[]	$mRequiredParameters = []

Detailed Description

Handler for unsubscribe links sent by SilverPop - ie the annoying emails we send begging for money at the start of new fundraising campaigns :)

Definition at line 26 of file FundraiserUnsubscribeSilverpop.php.

Constructor & Destructor Documentation

__construct()

FundraiserUnsubscribeSilverpop::__construct

(

)

Definition at line 60 of file FundraiserUnsubscribeSilverpop.php.

References SubscriptionMethod\addRequiredParameter().

Member Function Documentation

decodeEmail()

static FundraiserUnsubscribeSilverpop::decodeEmail ( array $params )

static

Decodes an email address that has been sent to us from SilverPop.

Parameters

array

$params

Returns

mixed|string

Definition at line 194 of file FundraiserUnsubscribeSilverpop.php.

processRemoteAction()

FundraiserUnsubscribeSilverpop::processRemoteAction	(		$txnName,
		DOMDocument	$dom,
		XmlTransactionProcessor &	$processObj )

Callback function from doTransaction()

Parameters

string	$txnName
DOMDocument	$dom
XmlTransactionProcessor	&$processObj

Returns

bool

Exceptions

MWException

Definition at line 117 of file FundraiserUnsubscribeSilverpop.php.

References $matches, and XmlTransactionProcessor\setEndpointURL().

update()

FundraiserUnsubscribeSilverpop::update	(		$requestID,
			$process,
		array	$params )

Performs the subscription action.

Parameters

int	$requestID	The log ID being used for this transaction
string	$process	The name of the currently executing subscription process
array	$params	Key/value map of URI parameter names => cleaned values

Returns

bool TRUE if the subscription action was successful.

Reimplemented from SubscriptionMethod.

Definition at line 69 of file FundraiserUnsubscribeSilverpop.php.

Member Data Documentation

$currentParams

string [] FundraiserUnsubscribeSilverpop::$currentParams = []

private

Definition at line 58 of file FundraiserUnsubscribeSilverpop.php.

$remoteActionEnvelope

string [] FundraiserUnsubscribeSilverpop::$remoteActionEnvelope = [ 'Envelope', 'Body' ]

private

Definition at line 30 of file FundraiserUnsubscribeSilverpop.php.

$remoteActionMap

array [] FundraiserUnsubscribeSilverpop::$remoteActionMap

private

Initial value:

= [
        'Login' => [
            'out' => [
                'USERNAME' => 'username',
                'PASSWORD' => 'password',
            ],
            'in' => 'processRemoteAction',
        ],
 
        'Logout' => [
            'out' => [],
            'in' => 'processRemoteAction',
        ],
 
        'OptOutRecipient' => [
            'out' => [
                'LIST_ID' => 'list-id',
                'MAILING_ID' => 'mailing-id',
                'RECIPIENT_ID' => 'recipient-id',
                'JOB_ID' => 'job-id',
            ],
            'in' => 'processRemoteAction',
        ],
    ]

Definition at line 32 of file FundraiserUnsubscribeSilverpop.php.

---

The documentation for this class was generated from the following file:

• extensions/FundraisingEmailUnsubscribe/methods/FundraiserUnsubscribeSilverpop.php