Maileon PHP client  1.2.5
Easily integrate your PHP application with Maileon.
com_maileon_api_contactfilters_ContactfiltersService Class Reference
Inheritance diagram for com_maileon_api_contactfilters_ContactfiltersService:
com_maileon_api_AbstractMaileonService

Public Member Functions

 getContactFiltersCount ()
 
 getContactFilters ($page_index=1, $page_size=10)
 
 getContactFilter ($contactFilterId)
 
 updateContactFilter ($contactFilterId, $newFilterObject)
 
 createContactFilter ($newFilterObject, $createTargetGroup)
 
 deleteContactFilter ($contactFilterId)
 
 refreshContactFilterContacts ($contactFilterId, $time)
 
- Public Member Functions inherited from com_maileon_api_AbstractMaileonService
 __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 Public Attributes inherited from com_maileon_api_AbstractMaileonService
static $MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml'
 
- Protected Member Functions inherited from com_maileon_api_AbstractMaileonService
 appendArrayFields ($params, $name, $fieldValues)
 
- Protected Attributes inherited from com_maileon_api_AbstractMaileonService
 $configuration
 
 $encodedApiKey
 
 $debug = false
 
 $throwException = true
 
 $proxy_host
 
 $proxy_port = 80
 
 $timeout
 

Detailed Description

Facade that wraps the REST service for contact filters.

Author
Felix Heinrichs | Trusted Mails GmbH | felix.heinrichs@trusted-mails.com
Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com

Definition at line 10 of file ContactfiltersService.php.

Member Function Documentation

com_maileon_api_contactfilters_ContactfiltersService::getContactFiltersCount ( )
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the count of defined contact filters available at com_maileon_api_MaileonAPIResult::getResult()

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.

Parameters
number$page_indexthe paging index of the page to fetch
number$page_sizethe number of entries to return per page
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_contactfilters_ContactFilter[] available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 34 of file ContactfiltersService.php.

com_maileon_api_contactfilters_ContactfiltersService::getContactFilter (   $contactFilterId)
Parameters
string$contactFilterId
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the com_maileon_api_contactfilters_ContactFilter available at com_maileon_api_MaileonAPIResult::getResult()

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.

Parameters
contactFilterIdthe ID of the contact filter to update
com_maileon_api_contactfilters_ContactFilter$newFilterObjectthe new data. Currently, the only field that is actually updated is the name of the filter.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call

Definition at line 64 of file ContactfiltersService.php.

com_maileon_api_contactfilters_ContactfiltersService::createContactFilter (   $newFilterObject,
  $createTargetGroup 
)

Creates a simple contact filter.

Parameters
com_maileon_api_contactfilters_ContactFilter$newFilterObjectthe data for the filter
bool$createTargetGroupif true, also a target group will be created and the ID will be returned
Returns
com_maileon_api_MaileonAPIResult the result object of the API call

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.

Parameters
contactFilterIdthe ID of the contact filter
Returns
com_maileon_api_MaileonAPIResult the result object of the API call

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.

Parameters
contactFilterIdthe ID of the contact filter to refresh
timea 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.
Returns
com_maileon_api_MaileonAPIResult the result object of the API call

Definition at line 112 of file ContactfiltersService.php.


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