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

Public Member Functions

 getAccountPlaceholders ()
 
 setAccountPlaceholders ($accountPlaceholders)
 
 updateAccountPlaceholders ($accountPlaceholders)
 
 deleteAccountPlaceholder ($name)
 
 sxml_append (SimpleXMLElement $to, SimpleXMLElement $from)
 
- 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 accounts.

Author
Marcus Beckerle | XQueue GmbH | marcus.beckerle@xqueue.com

Definition at line 8 of file AccountService.php.

Member Function Documentation

com_maileon_api_account_AccountService::getAccountPlaceholders ( )

Get list of all account placeholders.

Returns
com_maileon_api_MaileonAPIResult

Definition at line 18 of file AccountService.php.

com_maileon_api_account_AccountService::setAccountPlaceholders (   $accountPlaceholders)

Sets the list of account placeholders. All current account placeholders will be overwritten or removed, if not contained in the new array

Parameters
array$accountPlaceholdersArray of com_maileon_api_account_AccountPlaceholder or single account placeholder
Returns
com_maileon_api_MaileonAPIResult

Definition at line 30 of file AccountService.php.

com_maileon_api_account_AccountService::updateAccountPlaceholders (   $accountPlaceholders)

Update account placeholders. If account placeholder is not existing yet, it will be added. If account placeholder with given name is avaliable the value will be updated. Other existing account placeholders will not be touched.

Parameters
array$accountPlaceholdersArray of com_maileon_api_account_AccountPlaceholder or single account placeholder
Returns
com_maileon_api_MaileonAPIResult

Definition at line 52 of file AccountService.php.

com_maileon_api_account_AccountService::deleteAccountPlaceholder (   $name)

Delete account placeholder with requested

name
Parameters
string$nameThe name of the property to delete
Returns
com_maileon_api_MaileonAPIResult

Definition at line 74 of file AccountService.php.


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