![]() |
Maileon PHP client
1.5.0
Easily integrate your PHP application with Maileon.
|
Public Member Functions | |
getBlacklists () | |
getBlacklist ($id) | |
addEntriesToBlacklist ($id, $entries, $importName=null) | |
![]() | |
__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 | $MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml' |
![]() | |
appendArrayFields ($params, $name, $fieldValues) | |
![]() | |
$configuration | |
$encodedApiKey | |
$debug = false | |
$throwException = true | |
$proxy_host | |
$proxy_port = 80 | |
$timeout | |
Facade that wraps the REST service for blacklists.
Definition at line 7 of file BlacklistsService.php.
com_maileon_api_blacklists_BlacklistsService::getBlacklists | ( | ) |
Retrieves the names and IDs of the custom blacklists in your account.
com_maileon_api_MaileonAPIException | if 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.
integer | $id | the id of the blacklist to retrieve |
com_maileon_api_MaileonAPIException | if 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.
integer | $id | the id of the blacklist to add the entries to |
string[] | $entries the blacklist entries to add to the blacklist | |
string | $importName | a 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. |
com_maileon_api_MaileonAPIException | if there was a connection problem or a server error occurred |
Definition at line 52 of file BlacklistsService.php.