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

Public Member Functions

 createMailing ($name, $subject, $deprecatedParameter=false, $type="regular")
 
 getMailingIdByName ($mailingName)
 
 checkIfMailingExistsByName ($mailingName)
 
 disableQosChecks ($mailingId)
 
 setTriggerDispatchLogic ($mailingId, $logic)
 
 setTriggerActive ($mailingId)
 
 deleteActiveTriggerMailing ($mailingId)
 
 deleteMailing ($id)
 
 setHTMLContent ($mailingId, $html, $doImageGrabbing=true, $doLinkTracking=false)
 
 setTextContent ($mailingId, $text)
 
 getHTMLContent ($mailingId)
 
 getTextContent ($mailingId)
 
 setTargetGroupId ($mailingId, $targetGroupId)
 
 getTargetGroupId ($mailingId)
 
 setSender ($mailingId, $email)
 
 getSender ($mailingId)
 
 setSubject ($mailingId, $subject)
 
 getSubject ($mailingId)
 
 setPreviewText ($mailingId, $previewText)
 
 getPreviewText ($mailingId)
 
 setTemplate ($mailingId, $template)
 
 getTemplate ($mailingId)
 
 resetContentsToTemplate ($mailingId)
 
 setSenderAlias ($mailingId, $senderalias)
 
 setRecipientAlias ($mailingId, $recipientalias)
 
 getReplyToAddress ($mailingId)
 
 setReplyToAddress ($mailingId, $auto=true, $customEmail=null)
 
 getMailingsBySchedulingTime ($scheduleTime, $beforeSchedulingTime=true, $fields=array(), $page_index=1, $page_size=100, $orderBy="id", $order="DESC")
 
 getMailingsByTypes ($types, $fields=array(), $page_index=1, $page_size=100)
 
 sendMailingNow ($mailingId)
 
 setMailingSchedule ($mailingId, $date, $hours, $minutes)
 
 updateMailingSchedule ($mailingId, $date, $hours, $minutes)
 
 getDoiMailingKey ($mailingId)
 
 setDoiMailingKey ($mailingId, $doiKey)
 
 deactivateTriggerMailing ($mailingId)
 
 getTriggerDispatchLogic ($mailingId)
 
 getSchedule ($mailingId)
 
 getArchiveUrl ($mailingId)
 
 getReportUrl ($mailingId)
 
 setName ($mailingId, $name)
 
 getName ($mailingId)
 
 setTags ($mailingId, $tags)
 
 getTags ($mailingId)
 
 setLocale ($mailingId, $locale)
 
 getLocale ($mailingId)
 
 fillRssSmartContentTags ($mailingId)
 
 copyMailing ($mailingId)
 
 addAttachmentFromFile ($mailingId, $filename, $contentType, $attachmentFileName=null)
 
 addAttachment ($mailingId, $filename, $contentType, $contents)
 
 getAttachments ($mailingId)
 
 getAttachment ($mailingId, $attachmentId)
 
 getAttachmentsCount ($mailingId)
 
 deleteAttachments ($mailingId)
 
 deleteAttachment ($mailingId, $attachmentId)
 
 copyAttachments ($mailingId, $srcMailingId)
 
 getCustomProperties ($mailingId)
 
 addCustomProperties ($mailingId, $properties)
 
 updateCustomProperty ($mailingId, $property)
 
 deleteCustomProperty ($mailingId, $propertyName)
 
 sendTestMail ($mailingId, $email)
 
 sendTestMailToTestTargetGroup ($mailingId, $testTargetGroupId)
 
 sxml_append (SimpleXMLElement $to, SimpleXMLElement $from)
 
- 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 mailings.

Author
Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com
Andreas Lange | XQueue GmbH | andreas.lange@xqueue.com

Definition at line 9 of file MailingsService.php.

Member Function Documentation

com_maileon_api_mailings_MailingsService::createMailing (   $name,
  $subject,
  $deprecatedParameter = false,
  $type = "regular" 
)

Creates a new mailing.

Parameters
string$namethe name of the mailing
string$subjectthe subject of the mailing
bool$deprecatedParameterthis parameter was never used by the API
string$typethe type of the mailing, which can be one of 'doi', 'trigger', or 'regular'.
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 25 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getMailingIdByName (   $mailingName)

Get the ID of a mailing by its name

Definition at line 39 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::checkIfMailingExistsByName (   $mailingName)

Check if a mailing with the given name exists and return true or false

Definition at line 47 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::disableQosChecks (   $mailingId)

Disable all QoS checks for a given mailing

Definition at line 56 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTriggerDispatchLogic (   $mailingId,
  $logic 
)

Sets the dispatch logic for trigger mailings

Definition at line 64 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTriggerActive (   $mailingId)

Used for DOI Mailings

Definition at line 73 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deleteActiveTriggerMailing (   $mailingId)

Deletes an active trigger mailing.

Parameters
integer$idthe ID of the mailing to delete
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 85 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deleteMailing (   $id)

Deletes a mailing by ID.

Parameters
integer$idthe ID of the mailing to delete
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 97 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setHTMLContent (   $mailingId,
  $html,
  $doImageGrabbing = true,
  $doLinkTracking = false 
)

Updates the HTML content of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$htmlthe new HTML content of the mailing
bool$doImageGrabbingspecifies if image grabbing should be performed
bool$doLinkTrackingspecifies if link tracking should be performed
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 118 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTextContent (   $mailingId,
  $text 
)

Updates the TEXT content of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$textthe new TEXT content of the mailing
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 139 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getHTMLContent (   $mailingId)

Fetches the HTML content of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the HTML content string of the mailing 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 155 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getTextContent (   $mailingId)

Fetches the TEXT content of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the TEXT content string of the mailing 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 171 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTargetGroupId (   $mailingId,
  $targetGroupId 
)

Updates the target group id of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$targetGroupIdthe ID of the target group to set
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 188 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getTargetGroupId (   $mailingId)

Fetches the target group id of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the target group id of the mailing 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 204 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setSender (   $mailingId,
  $email 
)

Updates the sender email address of the mailing referenced by the given ID.
Note: if not only the local part but also the domain is provided, make sure that is exists in Maileon.

Parameters
string$mailingIdthe ID of the mailing to update
string$emailthe ID of the target group to set
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 222 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getSender (   $mailingId)

Fetches the sender email address of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the sender email address of the mailing 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 238 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setSubject (   $mailingId,
  $subject 
)

Updates the subject of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$subjectthe subject of the mailing to set
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 255 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getSubject (   $mailingId)

Fetches the subject of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the subject of the mailing 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 271 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setPreviewText (   $mailingId,
  $previewText 
)

Updates the preview text of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$previewTextthe preview text of the mailing to set, limit: 255 characters
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 288 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getPreviewText (   $mailingId)

Fetches the preview text of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the preview text of the mailing 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 304 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTemplate (   $mailingId,
  $template 
)

Sets the template for a mailing. Be careful, all HTML/text contents will be resettet. For templates from the same account, relative paths can be used in the form "my template" of with sub folders "someSubFolder/my template". For shared templates, an absolute path is required. The easiest way to find the correct path is to set the template manually and use getTemplate() to retrieve the name.

Parameters
string$mailingIdthe ID of the mailing to update
string$templatethe template id of the mailing to set
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 326 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getTemplate (   $mailingId)

Returns the template of the mailing with the provided id. For templates from the same account, relative paths will be returned in the form "my template" of with sub folders "someSubFolder/my template". For shared templates, an absolute path is returned.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the the corresponding template id of the mailing 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 344 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::resetContentsToTemplate (   $mailingId)

Resets the HTML/text contents of the mailing to its template state.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call 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 362 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setSenderAlias (   $mailingId,
  $senderalias 
)

Updates the senderalias of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$senderaliasthe sender alias to set
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 379 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setRecipientAlias (   $mailingId,
  $recipientalias 
)

Updates the recipientalias of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$recipientaliasthe recipient alias to set
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 396 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getReplyToAddress (   $mailingId)

Fetches the reply-to address of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the reply-to address of the mailing 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 412 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setReplyToAddress (   $mailingId,
  $auto = true,
  $customEmail = null 
)

Sets the reply-to address of the mailing identified by the given ID.

Parameters
string$mailingIdthe ID of the mailing
bool$auto(default = true) If true, the Maileon autorecognition will be used and emails will be saved within Maileon. If false, a custom email address can be passed which gets all mails forwarded.
string$customEmail(default = empty) If $auto is false, this email will be used for manual responses.
Returns
Exceptions
MaileonException

Definition at line 429 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getMailingsBySchedulingTime (   $scheduleTime,
  $beforeSchedulingTime = true,
  $fields = array(),
  $page_index = 1,
  $page_size = 100,
  $orderBy = "id",
  $order = "DESC" 
)

Types can be selected from 'doi','trigger', 'trigger_template' or 'regular'

See also
MailingFields
Parameters
string$scheduleTimeThis is a date and time string that defines the filter for a mailing. The mailings before and after that time can be queried, see beforeSchedulingTime. The format is the standard SQL date: yyyy-MM-dd HH:mm:ss
bool$beforeSchedulingTime(default = true) If true, the mailings before the given time will be returned, if false, the mailings at or after the given time will be returned.
string[]fields (default = empty) This list contains the fields that shall be returned with the result. If this list is empty, only the IDs will be returned. Valid fields are: state, type, name, and scheduleTime
numberpage_index (default = 1) The index of the result page. The index must be greater or equal to 1.
numberpage_size (default = 100) The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
stringorderBy (default = id) The field to order results by
stringorder (default = DESC) The order
Returns
Exceptions
MaileonException

Definition at line 461 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getMailingsByTypes (   $types,
  $fields = array(),
  $page_index = 1,
  $page_size = 100 
)

Types can be selected from 'doi','trigger', 'trigger_template' or 'regular'

See also
MailingFields
Parameters
string[]$types This is the list of types to filter for
string[]fields (default = empty) This list contains the fields that shall be returned with the result. If this list is empty, only the IDs will be returned. Valid fields are: state, type, name, and scheduleTime
numberpage_index (default = 1) The index of the result page. The index must be greater or equal to 1.
numberpage_size (default = 100) The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
Returns
Exceptions
MaileonException

Definition at line 493 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::sendMailingNow (   $mailingId)

Schedules the mailing to be instantly sent

Parameters
numbermailingId The ID of the mailing to send now
Returns
Exceptions
MaileonException

Definition at line 515 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setMailingSchedule (   $mailingId,
  $date,
  $hours,
  $minutes 
)

Schedules the mailing for a given time

Parameters
numbermailingId The ID of the mailing to schedule
datemailingId The SQL conform date of the schedule day in the format YYYY-MM-DD
hoursmailingId The schedule hour in the format of HH, 24 hours format
minutemailingId The schedule minutes in the format MM
Returns
Exceptions
MaileonException

Definition at line 534 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::updateMailingSchedule (   $mailingId,
  $date,
  $hours,
  $minutes 
)

Update the schedule for the given mailing

Parameters
numbermailingId The ID of the mailing to update the schedule for
datemailingId The SQL conform date of the schedule day in the format YYYY-MM-DD
hoursmailingId The schedule hour in the format of HH, 24 hours format
minutemailingId The schedule minutes in the format MM
Returns
Exceptions
MaileonException

Definition at line 559 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getDoiMailingKey (   $mailingId)

Fetches the DOI mailing key of the mailing identified by the given ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result object of the API call, with the target group id of the mailing 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 582 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setDoiMailingKey (   $mailingId,
  $doiKey 
)

Sets the key of the DOI mailing identified by the given ID.

Parameters
number$mailingIdthe ID of the mailing
string$doiKeyThe new DOI key.
Returns
Exceptions
MaileonException

Definition at line 597 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deactivateTriggerMailing (   $mailingId)

Deactivates a trigger mailing by ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 609 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getTriggerDispatchLogic (   $mailingId)

Get the dispatch data for a trigger mailing by mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 622 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getSchedule (   $mailingId)

Get the schedule for regular mailings by mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 635 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getArchiveUrl (   $mailingId)

Get the archive url for the mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 647 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getReportUrl (   $mailingId)

Get the report url for the mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 659 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setName (   $mailingId,
  $name 
)

Updates the name of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
string$namethe name of the mailing to set
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 676 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getName (   $mailingId)

Get the name for the mailing by mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 688 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setTags (   $mailingId,
  $tags 
)

Updates the tags of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
array$tagsthe tags
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 705 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getTags (   $mailingId)

Get the tags for the mailing identified by mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 717 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::setLocale (   $mailingId,
  $locale 
)

Updates the locale of the mailing referenced by the given ID.

Parameters
string$mailingIdthe ID of the mailing to update
stringlocale the locale in the form xx: e.g. de, en, fr, �
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 734 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getLocale (   $mailingId)

Get the locale for the mailing identified by mailing ID in the form xx: e.g. de, en, fr, �

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 746 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::fillRssSmartContentTags (   $mailingId)

Execute the RSS SmartMailing functionality for mailings, i.e. fill all SmartMailing Tags from the described RSS-Feeds. For more information about RSS-SmartMailing, please check our customer support at servi.nosp@m.ce@x.nosp@m.queue.nosp@m..com

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 759 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::copyMailing (   $mailingId)

Copy the mailing with the given mailing ID.

Parameters
number$mailingIdthe ID of the mailing
Returns
com_maileon_api_MaileonAPIResult the result of the operation

Definition at line 771 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::addAttachmentFromFile (   $mailingId,
  $filename,
  $contentType,
  $attachmentFileName = null 
)

Read a binary file from the file system and adds it as an attachment to this transaction.

Parameters
type$mailingId
type$filename
type$contentType
type$attachmentFileNameName of the file in the attachments
Returns
com_maileon_api_MaileonAPIResult
Exceptions
com_maileon_api_MaileonAPIException

Definition at line 787 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::addAttachment (   $mailingId,
  $filename,
  $contentType,
  $contents 
)

Adds an attachment to the mailing with the provided id.

Parameters
int$mailingIdThe mailing id
string$filenameFilename of the attachment to be displayed in sent emails. It is recommended to keep the filename short and to use an extension corresponding to the mime type of the attachment.
string$contentTypeThe mime type of the attachment
string$contentsThe file content
Returns
com_maileon_api_MaileonAPIResult

Definition at line 815 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getAttachments (   $mailingId)

Returns a list of the registered attachments for the mailing with the provided id.

Parameters
int$mailingId
Returns
com_maileon_api_MaileonAPIResult

Definition at line 827 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getAttachment (   $mailingId,
  $attachmentId 
)

Returns the attachment with the provided id as a file.

Parameters
int$mailingId
int$attachmentId
Returns
com_maileon_api_MaileonAPIResult

Definition at line 839 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getAttachmentsCount (   $mailingId)

Returns the count of available attachments in the mailing with the provided id.

Parameters
int$mailingId
Returns
com_maileon_api_MaileonAPIResult

Definition at line 850 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deleteAttachments (   $mailingId)

Deletes all the attachments that belong to the mailing with the provided id. The mailing should not be sealed.

Parameters
int$mailingId
Returns
type

Definition at line 861 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deleteAttachment (   $mailingId,
  $attachmentId 
)

Deletes the attachment with the provided id from the mailing. The mailing should not be sealed.

Parameters
int$mailingId
int$attachmentId
Returns
com_maileon_api_MaileonAPIResult
Exceptions
com_maileon_api_MaileonAPIException

Definition at line 875 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::copyAttachments (   $mailingId,
  $srcMailingId 
)

Copies the attachments of a source mailing into a target mailing. Note that the target mailing should not be sealed and that the resulting total count of attachments in the target mailing should not exceed 10.

Parameters
int$mailingId
int$srcMailingId
Returns
com_maileon_api_MaileonAPIResult

Definition at line 891 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::getCustomProperties (   $mailingId)

Returns a list of custom properties for the mailing with the provided id.

Parameters
int$mailingId
Returns
com_maileon_api_MaileonAPIResult

Definition at line 904 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::addCustomProperties (   $mailingId,
  $properties 
)

Adds a list of custom properties to the mailing with the provided id.

Parameters
int$mailingId
array$propertiesArray of com_maileon_api_mailings_CustomProperty or single property
Returns
com_maileon_api_MaileonAPIResult

Definition at line 917 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::updateCustomProperty (   $mailingId,
  $property 
)

Updates a custom property of the mailing with the provided id.

Parameters
int$mailingId
com_maileon_api_mailings_CustomProperty$property
Returns
com_maileon_api_MaileonAPIResult

Definition at line 941 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::deleteCustomProperty (   $mailingId,
  $propertyName 
)

Deletes a custom property of the mailing with the provided id.

Parameters
int$mailingId
string$propertyNameThe name of the property to delete
Returns
com_maileon_api_MaileonAPIResult

Definition at line 960 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::sendTestMail (   $mailingId,
  $email 
)

Sends a testmail for the mailing with the provided id to a given email address. If the email address does not exist within your contacts, the personalization is done according to your default personalization user configured in Maileon.

Documentation website

Parameters
mailingIdid of existing mailing
emailemail address
Exceptions
MaileonException

Definition at line 981 of file MailingsService.php.

com_maileon_api_mailings_MailingsService::sendTestMailToTestTargetGroup (   $mailingId,
  $testTargetGroupId 
)

Sends a testmail for the mailing with the provided id to a test-targetgroup givenby its ID.

Parameters
mailingId
testTargetGroupId
Exceptions
MaileonException

Definition at line 997 of file MailingsService.php.


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