/**
* Get all Messages
*
* @param Array $parameters Associative array with archivedMessages property.
*
* @return messageTypeItems array
*/
public function getAll($parameters = NULL)
{
$request = NULL;
if (isset($parameters) && (array_key_exists("archivedMessages", $parameters) && $parameters["archivedMessages"])) {
$request = FlexmailAPI::parseArray($parameters);
}
$response = $this->execute("GetMessages", $request);
return FlexmailAPI::stripHeader($response, $this->config->get('debug_mode'));
}
/**
* Delete a Landing Page
*
* Parmeters example:
* ------------------
* $parameters = array (
* "landingPageType" => array ( // array mandatory
* "landingPageId" => 14954 // intmandatory
* )
* );
*
* @param Array $parameters Associative array with properties of an landingPageType object
*
* @return void
*/
public function delete($parameters)
{
$request = FlexmailAPI::parseArray($parameters);
$response = $this->execute("DeleteLandingPage", $request);
return FlexmailAPI::stripHeader($response, $this->config->get('debug_mode'));
}
/**
* Get all Mailinglists within a Category
*
* @param Array $parameters Associative array with categoryId
*
* @return mailingListTypeItems array
*/
public function getAll($parameters)
{
$request = FlexmailAPI::parseArray($parameters);
$response = $this->execute("GetMailingLists", $request);
return FlexmailAPI::stripHeader($response, $this->config->get('debug_mode'));
}
/**
* Request complete or partial history for all email addresses in a campaign
*
* Parmeters example:
* ------------------
* $parameters = array (
* "campaignId" => 12345, // int mandatory
* "timestampFrom" => "2008-09-20T09:00:00", // string optional
* "timestampTill" => "2013-09-20T09:00:00", // string optional
* "campaignHistoryOptions" => array ( // array optional
* "campaignSend" => true, // boolean optional
* "campaignRead" => true, // boolean optional
* "campaignReadOnline" => true, // boolean optional
* "campaignLinkClicked" => true, // boolean optional
* "campaignLinkGroupClicked" => true, // boolean optional
* "campaignReadInfoPage" => true, // boolean optional
* "campaignFormVisited" => true, // boolean optional
* "campaignFormSubmitted" => true, // boolean optional
* "campaignFormSubmitted" => true, // boolean optional
* "campaignSurveySubmitted" => true, // boolean optional
* "campaignForwardSubmitted" => true, // boolean optional
* "campaignForwardVisited" => true // boolean optional
* ),
* "sort" => 0 // integer optional
*
*
*
* @param Array $parameters Ass. array with campaignId, optional TimeStampFrom,
* TimeStampTill and sort parameters and optional
* array with properties for campaignHistoryOptionsType object
*
* @return campaignHistoryType
*/
public function history($parameters)
{
$request = FlexmailAPI::parseArray($parameters);
$response = $this->execute("GetCampaignHistory", $request);
return FlexmailAPI::stripHeader($response, $this->config->get('debug_mode'));
}
/**
* Import multiple email adresses to the overall or a specific mailing list blacklist
*
*
* $importBlacklistParameters = array (
* "emailAddressTypeItems" => array( // array mandatory
* array (
* "emailAddress" => "*****@*****.**" // string mandatory
* ),
* array (
* "emailAddress" => "*****@*****.**" // string mandatory
* )
* ),
* "mailingListTypeItems" => array ( // array optional
* array (
* "mailingListId" => 117115 // int mandatory
* ),
* array (
* "mailingListId" => 117081 // int mandatory
* )
* )
* );
*
* @param Array $parameters Array with array of emailAddressType objects
* and array with mailingListType objects
*
* @return importBlackListREspTypeItems array
*/
public function import($parameters)
{
$request = FlexmailAPI::parseArray($parameters);
$response = $this->execute("ImportBlacklist", $request);
return FlexmailAPI::stripHeader($response, $this->config->get('debug_mode'));
}
