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

Public Member Functions

 pingGet ()
 
 pingPut ()
 
 pingPost ()
 
 pingDelete ()
 
 checkResult ($result)
 
- 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)
 

Public Attributes

const PING_RESOURCE = "ping"
 

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

A facade that wraps the REST "ping" system interface monitoring service.

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 9 of file PingService.php.

Member Function Documentation

com_maileon_api_utils_PingService::pingGet ( )

Tests if sending GET requests to the REST API works.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 21 of file PingService.php.

com_maileon_api_utils_PingService::pingPut ( )

Tests if sending PUT requests to the REST API works.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 34 of file PingService.php.

com_maileon_api_utils_PingService::pingPost ( )

Tests if sending POST requests to the REST API works.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 47 of file PingService.php.

com_maileon_api_utils_PingService::pingDelete ( )

Tests if sending DELETE requests to the REST API works.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 60 of file PingService.php.

com_maileon_api_utils_PingService::checkResult (   $result)

Convenience method to check whether the API call succeeded or not.

Parameters
array$resulta result wrapper as returned from one of the ping methods in this class
Returns
com_maileon_api_MaileonAPIResult the result object of the API call
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 75 of file PingService.php.


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