![]() |
Maileon PHP client
1.2.5
Easily integrate your PHP application with Maileon.
|
Public Member Functions | |
getContactFiltersCount () | |
getContactFilters ($page_index=1, $page_size=10) | |
getContactFilter ($contactFilterId) | |
updateContactFilter ($contactFilterId, $newFilterObject) | |
createContactFilter ($newFilterObject, $createTargetGroup) | |
deleteContactFilter ($contactFilterId) | |
refreshContactFilterContacts ($contactFilterId, $time) | |
![]() | |
__construct (array $config) | |
setDebug ($isDebug) | |
isDebug () | |
get ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) | |
put ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) | |
post ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) | |
delete ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) | |
Additional Inherited Members | |
![]() | |
static | $MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml' |
![]() | |
appendArrayFields ($params, $name, $fieldValues) | |
![]() | |
$configuration | |
$encodedApiKey | |
$debug = false | |
$throwException = true | |
$proxy_host | |
$proxy_port = 80 | |
$timeout | |
Facade that wraps the REST service for contact filters.
Definition at line 10 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::getContactFiltersCount | ( | ) |
Definition at line 18 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::getContactFilters | ( | $page_index = 1 , |
|
$page_size = 10 |
|||
) |
Returns the defined contact filters.
number | $page_index | the paging index of the page to fetch |
number | $page_size | the number of entries to return per page |
Definition at line 34 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::getContactFilter | ( | $contactFilterId | ) |
string | $contactFilterId |
Definition at line 49 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::updateContactFilter | ( | $contactFilterId, | |
$newFilterObject | |||
) |
Updates a contact filter that is referenced by an ID.
contactFilterId | the ID of the contact filter to update | |
com_maileon_api_contactfilters_ContactFilter | $newFilterObject | the new data. Currently, the only field that is actually updated is the name of the filter. |
Definition at line 64 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::createContactFilter | ( | $newFilterObject, | |
$createTargetGroup | |||
) |
Creates a simple contact filter.
com_maileon_api_contactfilters_ContactFilter | $newFilterObject | the data for the filter |
bool | $createTargetGroup | if true, also a target group will be created and the ID will be returned |
Definition at line 79 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::deleteContactFilter | ( | $contactFilterId | ) |
Deletes a contact filter that is referenced by an ID.
contactFilterId | the ID of the contact filter |
Definition at line 95 of file ContactfiltersService.php.
com_maileon_api_contactfilters_ContactfiltersService::refreshContactFilterContacts | ( | $contactFilterId, | |
$time | |||
) |
Causes a refresh of the contact filter referenced by an ID. This means that the result set of contacts matched by the contact filter is recomputed.
contactFilterId | the ID of the contact filter to refresh |
time | a timestamp for the request. If the contact filter was updated after the given timestamp, the refresh is not performed. The default value will force the refresh to always be performed. |
Definition at line 112 of file ContactfiltersService.php.