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

Public Member Functions

 getTargetGroupsCount ()
 
 getTargetGroups ($page_index=1, $page_size=10)
 
 getTargetGroup ($targetGroupId)
 
 createTargetGroup ($targetGroup)
 
 deleteTargetGroup ($targetGroupId)
 
- 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, $contentType=null, $contentLength=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 target groups

Author
Marcus Ständer

Definition at line 8 of file TargetGroupsService.php.

Member Function Documentation

com_maileon_api_targetgroups_TargetGroupsService::getTargetGroupsCount ( )
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the count of defined target groups available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 17 of file TargetGroupsService.php.

com_maileon_api_targetgroups_TargetGroupsService::getTargetGroups (   $page_index = 1,
  $page_size = 10 
)

Returns the defined target groups.

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_targetgroups_TargetGroup available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 33 of file TargetGroupsService.php.

com_maileon_api_targetgroups_TargetGroupsService::getTargetGroup (   $targetGroupId)
Parameters
string$targetGroupId
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the com_maileon_api_targetgroups_TargetGroup available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 48 of file TargetGroupsService.php.

com_maileon_api_targetgroups_TargetGroupsService::createTargetGroup (   $targetGroup)

Create a target group

Parameters
com_maileon_api_targetgroups_TargetGroup$targetGroup
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the com_maileon_api_targetgroups_TargetGroup available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 60 of file TargetGroupsService.php.

com_maileon_api_targetgroups_TargetGroupsService::deleteTargetGroup (   $targetGroupId)
Parameters
string$targetGroupId
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the deleted com_maileon_api_targetgroups_TargetGroup available at com_maileon_api_MaileonAPIResult::getResult()

Definition at line 71 of file TargetGroupsService.php.


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