CRM_Utils_SoapServer

class CRM_Utils_SoapServer

This class handles all SOAP client requests.

Properties

static int $soap_timeout Number of seconds we should let a soap process idle
string $ufClass Cache the actual UF Class

Methods

__construct()

Class constructor. This caches the real user framework class locally, so we can use it for authentication and validation.

string
ping(string $var)

Simple ping function to test for liveness.

verify(string $key)

Verify a SOAP key.

string
authenticate(string $name, string $pass, bool $loadCMSBootstrap = FALSE)

Authentication wrapper to the UF Class.

array|int
mailer_event_bounce(string $key, int $job, int $queue, string $hash, string $body)

MAILER API.

array|int
mailer_event_unsubscribe(string $key, int $job, int $queue, string $hash)

Mailer event unsubscribe.

array|int
mailer_event_domain_unsubscribe($key, $job, $queue, $hash)

No description

array|int
mailer_event_resubscribe($key, $job, $queue, $hash)

No description

array|int
mailer_event_subscribe($key, $email, $domain, $group)

No description

array|int
mailer_event_confirm($key, $contact, $subscribe, $hash)

No description

array|int
mailer_event_reply($key, $job, $queue, $hash, $bodyTxt, $rt, null $bodyHTML = NULL, null $fullEmail = NULL)

No description

array|int
mailer_event_forward($key, $job, $queue, $hash, $email)

No description

array|int
get_contact($key, array $params)

No description

Details

at line 54
__construct()

Class constructor. This caches the real user framework class locally, so we can use it for authentication and validation.

at line 69
string ping(string $var)

Simple ping function to test for liveness.

Parameters

string $var The string to be echoed.

Return Value

string

at line 84
verify(string $key)

Verify a SOAP key.

Parameters

string $key The soap key generated by authenticate().

Exceptions

SoapFault

at line 119
string authenticate(string $name, string $pass, bool $loadCMSBootstrap = FALSE)

Authentication wrapper to the UF Class.

Parameters

string $name Login name.
string $pass Password.
bool $loadCMSBootstrap

Return Value

string The SOAP Client key

Exceptions

SoapFault

at line 152
array|int mailer_event_bounce(string $key, int $job, int $queue, string $hash, string $body)

MAILER API.

Parameters

string $key
int $job
int $queue
string $hash
string $body

Return Value

array|int

Exceptions

SoapFault

at line 177
array|int mailer_event_unsubscribe(string $key, int $job, int $queue, string $hash)

Mailer event unsubscribe.

Parameters

string $key
int $job
int $queue
string $hash

Return Value

array|int

Exceptions

SoapFault

at line 200
array|int mailer_event_domain_unsubscribe($key, $job, $queue, $hash)

Parameters

$key
$job
$queue
$hash

Return Value

array|int

Exceptions

SoapFault

at line 223
array|int mailer_event_resubscribe($key, $job, $queue, $hash)

Parameters

$key
$job
$queue
$hash

Return Value

array|int

Exceptions

SoapFault

at line 246
array|int mailer_event_subscribe($key, $email, $domain, $group)

Parameters

$key
$email
$domain
$group

Return Value

array|int

Exceptions

SoapFault

at line 266
array|int mailer_event_confirm($key, $contact, $subscribe, $hash)

Parameters

$key
$contact
$subscribe
$hash

Return Value

array|int

Exceptions

SoapFault

at line 293
array|int mailer_event_reply($key, $job, $queue, $hash, $bodyTxt, $rt, null $bodyHTML = NULL, null $fullEmail = NULL)

Parameters

$key
$job
$queue
$hash
$bodyTxt
$rt
null $bodyHTML
null $fullEmail

Return Value

array|int

Exceptions

SoapFault

at line 320
array|int mailer_event_forward($key, $job, $queue, $hash, $email)

Parameters

$key
$job
$queue
$hash
$email

Return Value

array|int

Exceptions

SoapFault

at line 340
array|int get_contact($key, array $params)

Parameters

$key
array $params

Return Value

array|int

Exceptions

SoapFault