MailingsService.php

<?php

class com_maileon_api_mailings_MailingsService extends com_maileon_api_AbstractMaileonService
{

    function createMailing($name, $subject, $deprecatedParameter = false, $type = "regular")
    {
        $queryParameters = array(
            'name' => urlencode($name),
            'subject' => urlencode($subject),
            'type' => urlencode($type),
        );

        return $this->post('mailings', "", $queryParameters);
    }

    function getMailingIdByName($mailingName)
    {
        return $this->get('mailings/name/' . urlencode($mailingName));
    }

    function checkIfMailingExistsByName($mailingName)
    {
        $response = $this->get('mailings/name/' . urlencode($mailingName));
        return ($response->isSuccess());
    }

    function disableQosChecks($mailingId)
    {
        return $this->put('mailings/' . $mailingId . '/settings/disableQosChecks');
    }

    function setTriggerDispatchLogic($mailingId, $logic)
    {
        $queryParameters = array();
        return $this->put('mailings/' . $mailingId . '/dispatching', $logic, $queryParameters);
    }

    function setTriggerActive($mailingId)
    {
        return $this->post('mailings/' . $mailingId . '/dispatching/activate', "");
    }

    function deleteActiveTriggerMailing($mailingId)
    {
        return $this->delete("mailings/".$mailingId."/dispatching");
    }

    function deleteMailing($id)
    {
        return $this->delete("mailings/".$id);
    }

    function setHTMLContent($mailingId, $html, $doImageGrabbing = true, $doLinkTracking = false)
    {
        $queryParameters = array(
            'doImageGrabbing' => ($doImageGrabbing == TRUE) ? "true" : "false",
            'doLinkTracking' => ($doLinkTracking == TRUE) ? "true" : "false"
        );
        return $this->post('mailings/' . $mailingId . '/contents/html', $html, $queryParameters, "text/html");
    }

    function setTextContent($mailingId, $text)
    {
        return $this->post('mailings/' . $mailingId . '/contents/text', $text, array(), "text/plain");
    }

    function getHTMLContent($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/contents/html', null, "text/html");
    }

    function getTextContent($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/contents/text', null, "text/plain");
    }

    function setTargetGroupId($mailingId, $targetGroupId)
    {
        return $this->post('mailings/' . $mailingId . '/targetgroupid', "<targetgroupid>" . $targetGroupId . "</targetgroupid>");
    }

    function getTargetGroupId($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/targetgroupid', null);
    }

    function setSender($mailingId, $email)
    {
        return $this->post('mailings/' . $mailingId . '/contents/sender', "<sender>" . $email . "</sender>");
    }

    function getSender($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/contents/sender');
    }

    function setSubject($mailingId, $subject)
    {
        return $this->post('mailings/' . $mailingId . '/contents/subject', "<subject>" . $subject . "</subject>");
    }

    function getSubject($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/contents/subject');
    }
    
    function setSenderAlias($mailingId, $senderalias)
    {
        return $this->post('mailings/' . $mailingId . '/contents/senderalias', "<senderalias>" . $senderalias . "</senderalias>");
    }

    function setRecipientAlias($mailingId, $recipientalias)
    {
        return $this->post('mailings/' . $mailingId . '/contents/recipientalias', "<recipientalias>" . $recipientalias . "</recipientalias>");
    }

    function getReplyToAddress($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/settings/replyto');
    }

    function setReplyToAddress($mailingId, $auto = true, $customEmail = null)
    {
        $queryParameters = array(
            'auto' => ($auto == TRUE) ? "true" : "false",
            'customEmail' => $customEmail
        );

        return $this->post('mailings/' . $mailingId . '/settings/replyto', null, $queryParameters);
    }

    function getMailingsBySchedulingTime($scheduleTime, $beforeSchedulingTime = true, $fields = array(), $page_index = 1, $page_size = 100, $orderBy = "id", $order = "DESC")
    {
        $queryParameters = array(
            'page_index' => $page_index,
            'page_size' => $page_size,
            'scheduleTime' => urlencode($scheduleTime),
            'beforeSchedulingTime' => ($beforeSchedulingTime == TRUE) ? "true" : "false",
            'orderBy' => $orderBy,
            'order' => $order
        );

        $queryParameters = $this->appendArrayFields($queryParameters, "fields", $fields);

        return $this->get('mailings/filter/scheduletime', $queryParameters);
    }

    function getMailingsByTypes($types, $fields = array(), $page_index = 1, $page_size = 100)
    {
        $queryParameters = array(
            'page_index' => $page_index,
            'page_size' => $page_size,
            'order' => "DESC"
        );

        $queryParameters = $this->appendArrayFields($queryParameters, "types", $types);
        $queryParameters = $this->appendArrayFields($queryParameters, "fields", $fields);

        return $this->get('mailings/filter/types', $queryParameters);
    }

    function sendMailingNow($mailingId)
    {
        return $this->post('mailings/' . $mailingId . '/sendnow');
    }



    function getDoiMailingKey($mailingId)
    {
        return $this->get('mailings/' . $mailingId . '/settings/doi_key', null, "text/html");
    }

    function setDoiMailingKey($mailingId, $doiKey)
    {
        return $this->post('mailings/' . $mailingId . '/settings/doi_key', "<doi_key>$doiKey</doi_key>");
    }

    function deactivateTriggerMailing($mailingId)
    {
        return $this->delete("mailings/${mailingId}/dispatching");
    }



    function getTriggerDispatchLogic($mailingId)
    {
        return $this->get("mailings/${mailingId}/dispatching");
    }


    function getSchedule($mailingId)
    {
        return $this->get("mailings/${mailingId}/schedule");
    }

    function getArchiveUrl($mailingId)
    {
        return $this->get("mailings/${mailingId}/archiveurl");
    }

    function setName($mailingId, $name)
    {
        return $this->post('mailings/' . $mailingId . '/name', "<name>" . $name . "</name>");
    }

    function getName($mailingId)
    {
        return $this->get("mailings/${mailingId}/name");
    }

    function setTags($mailingId, $tags)
    {
        return $this->post('mailings/' . $mailingId . '/settings/tags', "<tags>" . join("#", $tags) . "</tags>");
    }

    function getTags($mailingId)
    {
        return $this->get("mailings/${mailingId}/settings/tags");
    }

    function setLocale($mailingId, $locale)
    {
        return $this->post('mailings/' . $mailingId . '/settings/locale', "<locale>$locale</locale>");
    }

    function getLocale($mailingId)
    {
        return $this->get("mailings/${mailingId}/settings/locale");
    }

    function fillRssSmartContentTags($mailingId)
    {
        return $this->post("mailings/${mailingId}/contents/smartmailing/rss");
    }

    function copyMailing($mailingId)
    {
        return $this->post("mailings/${mailingId}/copy");
    }
    
    function addAttachmentFromFile($mailingId, $filename, $contentType, $attachmentFileName = null) {
        $handle = fopen($filename, "rb");
        if (FALSE === $filename) {
            throw new com_maileon_api_MaileonAPIException("Cannot read file " . $filename . ".");
        }
        $contents = '';
        while (!feof($handle)) {
            $contents .= fread($handle, 8192);
        }
        fclose($handle);
        if ($attachmentFileName === null) {
            $attachmentFileName = basename($filename);
        }
        
        return $this->addAttachment($mailingId, $attachmentFileName, $contentType, $contents);
    }
    
    function addAttachment($mailingId, $filename, $contentType, $contents) {
        $queryParameters = array( 'filename' => $filename );
        return $this->post("mailings/${mailingId}/attachments", $contents, $queryParameters, null, null, $contentType, strlen($contents));
    }
    
    function getAttachments($mailingId) {
        return $this->get("mailings/${mailingId}/attachments");
    }
    
    function getAttachment($mailingId, $attachmentId) {
        return $this->get("mailings/${mailingId}/attachments/${attachmentId}");
    }
    
    function getAttachmentsCount($mailingId) {
        return $this->get("mailings/${mailingId}/attachments/count");
    }
    
    function deleteAttachments($mailingId) {
        return $this->delete("mailings/${mailingId}/attachments/");
    }
    
    function deleteAttachment($mailingId, $attachmentId) {
        if(empty($attachmentId)) { throw new com_maileon_api_MaileonAPIException("no attachment id specified"); }
        
        return $this->delete("mailings/${mailingId}/attachments/${attachmentId}");
    }
    
    function copyAttachments($mailingId, $srcMailingId) {
        $queryParameters = array( 'src_mailing_id' => $srcMailingId );
        
        return $this->put("mailings/${mailingId}/attachments", "", $queryParameters);
    }

    function getCustomProperties($mailingId) {
        return $this->get("mailings/${mailingId}/settings/properties");
    }


    function addCustomProperties($mailingId, $properties) {

        $xml = new SimpleXMLElement("<?xml version=\"1.0\"?><properties></properties>");

        if (is_array($properties)) {
            foreach ($properties as $property) {
                $this->sxml_append($xml, $property->toXML());
            }
        } else {
            $this->sxml_append($xml, $properties->toXML());
        }

        return $this->post("mailings/${mailingId}/settings/properties", $xml->asXML());
    }


    function updateCustomProperty($mailingId, $property) {

        $queryParameters = array(
            'name' => $property->key,
            'value' => $property->value
        );

        return $this->put("mailings/${mailingId}/settings/properties", "", $queryParameters);
    }


    function deleteCustomProperty($mailingId, $propertyName) {

        $queryParameters = array(
            'name' => $propertyName,
        );

        return $this->delete("mailings/${mailingId}/settings/properties", $queryParameters);
    }

    function sxml_append(SimpleXMLElement $to, SimpleXMLElement $from) {
        $toDom = dom_import_simplexml($to);
        $fromDom = dom_import_simplexml($from);
        $toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));
    }

}