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

Public Member Functions

 getBlacklists ()
 
 getBlacklist ($id)
 
 addEntriesToBlacklist ($id, $entries, $importName=null)
 
- 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 blacklists.

Definition at line 7 of file BlacklistsService.php.

Member Function Documentation

com_maileon_api_blacklists_BlacklistsService::getBlacklists ( )

Retrieves the names and IDs of the custom blacklists in your account.

Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with a com_maileon_api_blacklists_Blacklist[] available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 18 of file BlacklistsService.php.

com_maileon_api_blacklists_BlacklistsService::getBlacklist (   $id)

Retrieves a full blacklist (including entries) by id.

Parameters
integer$idthe id of the blacklist to retrieve
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the requested com_maileon_api_blacklists_Blacklist available at com_maileon_api_MaileonAPIResult::getResult()
Exceptions
com_maileon_api_MaileonAPIExceptionif there was a connection problem or a server error occurred

Definition at line 33 of file BlacklistsService.php.

com_maileon_api_blacklists_BlacklistsService::addEntriesToBlacklist (   $id,
  $entries,
  $importName = null 
)

Adds a number of expressions to a blacklist.

Parameters
integer$idthe id of the blacklist to add the entries to
string[]$entries the blacklist entries to add to the blacklist
string$importNamea unique name for the import that will be displayed in Maileon's web user interface. If this is null, a unique name will be generated.
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 52 of file BlacklistsService.php.


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