Class Inx_Apiimpl_Mailing_MailingImpl

Description

Implements interfaces:

MailingImpl

MailingImpl

  • version: $Revision: 7335 $ $Date: 2007-09-10 14:58:22 +0200 (Mo, 10 Sep 2007) $ $Author: sbn $

Located in /Apiimpl/Mailing/MailingImpl.php (line 8)


	
			
Variable Summary
Method Summary
static unknown convert (Inx_Apiimpl_SessionContext $oSc, array $aData, Inx_Apiimpl_Mailing_MailingManagerImpl $oMailingManager)
Inx_Apiimpl_Mailing_MailingImpl __construct (Inx_Apiimpl_SessionContext $oSc, Inx_Apiimpl_Mailing_MailingManagerImpl $oMailingManager, [ $oData = null], [int $iListContextId = null], [int $iFeatureId = null])
void approve ([ $approverId = 0], [ $comment = null])
void checkLazyData ()
void commitUpdate ()
void denyApprove ( $approverId,  $comment)
void findLastSending ()
void findSendings ()
void getFeatureId ()
void getFilterId ()
void getFilterIds ()
int getId ()
void getName ()
Integer getPriority ()
String getSenderAddress ()
void getSendingInfo ()
Date getSentDatetime ()
int getState ()
void getSubject ()
boolean isLocked ()
void lock ()
void refreshData ( $oData)
void reload ()
void requestApproval ()
void requestEscalationApproval ( $escalationDate,  $deadline,  $approverIds,  $recipientIds,  $isTestRecipient,  $locale)
void requestIdenticalApproval ( $deadline,  $approverIds,  $recipientIds,  $isTestRecipient,  $locale)
void revokeApproval ([ $comment = null])
void scheduleMailing ([ $scheduleTime = null])
void sendSingleMail (int $iRecipientId)
null sendTestMail (string $sTestAddress, int $iRecipientId)
void sendTestMailWithTestprofile ( $sTestAddress,  $iTestprofileId)
void setContentHandler (string $sContentHandlerClazz)
void startSending ()
void stopSending ()
unknown unlock ([boolean $blForceForeignLock = false])
void updateFilterId ( $iFilterId)
void updateFilterIds ( $filterIds,  $concatinationType)
void updateName (String $sName)
void updatePriority (Integer $iPriority)
void updateRecipientAddress (String $sRecipientAddress)
void updateReplyToAddress (String $sReplyToAddress)
void updateScheduleDatetime (Date $dtScheduleDatetime)
void updateSenderAddress (String $sSenderAddress)
void updateSubject (String $sSubject)
Variables
Inx_Apiimpl_Mailing_MailingContentHandler $oContentHandler (line 44)

Enter description here.

Enter description here...

  • access: public
stdClass $oData (line 30)

Enter description here.

Enter description here...

  • access: public
Inx_Api_LockTicket $oLock (line 37)

Enter description here.

Enter description here...

  • access: protected

Enter description here.

Enter description here...

  • access: public
array $_aChangedAttrs (line 51)

Enter description here.

Enter description here...

  • access: public
type $_oMailingManager (line 23)
  • var: Inx_Apiimpl_Mailing_MailingManagerImpl
  • access: protected
mixed $_oMService (line 18)
  • access: protected
Methods
static method convert (line 906)

Enter description here.

Enter description here...

  • access: public
static unknown convert (Inx_Apiimpl_SessionContext $oSc, array $aData, Inx_Apiimpl_Mailing_MailingManagerImpl $oMailingManager)
static method createSendException (line 994)

Enter description here.

Enter description here...

  • access: protected
static Inx_Api_Mailing_SendException createSendException ( $x)
  • stdClass $x
static method createStateException (line 983)

Enter description here.

Enter description here...

  • access: protected
static Inx_Api_Mailing_MailingStateException createStateException ( $x)
  • stdClass $x
Constructor __construct (line 63)

Enter description here.

Enter description here...

  • access: public
Inx_Apiimpl_Mailing_MailingImpl __construct (Inx_Apiimpl_SessionContext $oSc, Inx_Apiimpl_Mailing_MailingManagerImpl $oMailingManager, [ $oData = null], [int $iListContextId = null], [int $iFeatureId = null])
approve (line 272)
  • access: public
void approve ([ $approverId = 0], [ $comment = null])
  • $approverId
  • $comment

Implementation of:
Inx_Api_Mailing_Mailing::approve()
Approve this mailing for sending.
checkLazyData (line 933)
  • access: public
void checkLazyData ()
checkWriteAccess (line 926)
  • access: public
void checkWriteAccess ()
commitUpdate (line 843)

Enter description here.

Enter description here...

  • throws: Inx_Api_UpdateException, Inx_Api_DataException
  • access: public
void commitUpdate ()

Implementation of:
Inx_Api_BusinessObject::commitUpdate()
Passes all changes made since the last commit to the server.
denyApprove (line 279)
  • access: public
void denyApprove ( $approverId,  $comment)
  • $approverId
  • $comment

Implementation of:
Inx_Api_Mailing_Mailing::denyApprove()
Deny approval of this mailing.
findLastSending (line 266)
  • access: public
void findLastSending ()

Implementation of:
Inx_Api_Mailing_Mailing::findLastSending()
Returns the Inx_Api_Sending_Sending object for the last sending of this mailing, if any.
findSendings (line 260)
  • access: public
void findSendings ()

Implementation of:
Inx_Api_Mailing_Mailing::findSendings()
Returns an Inx_Api_ROBOResultSet containing all sendings of this mailing.
getContentHandler (line 809)
  • access: public
void getContentHandler ()

Implementation of:
Inx_Api_Mailing_Mailing::getContentHandler()
Returns the content handler, which contains the format-specific mail content.
getCreationDatetime (line 595)
  • access: public
void getCreationDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getCreationDatetime()
Returns the create date of the mailing
getDeadlineDatetime (line 584)
  • access: public
void getDeadlineDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getDeadlineDatetime()
Returns the approval deadline datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE.
getEscalationDatetime (line 590)
  • access: public
void getEscalationDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getEscalationDatetime()
Returns the approval escalation datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE and the approval process is escalating.
getFeatureId (line 615)
  • access: public
void getFeatureId ()
getFilterConcatinationType (line 656)
  • access: public
void getFilterConcatinationType ()

Implementation of:
Inx_Api_Mailing_Mailing::getFilterConcatinationType()
Returns the sending filter concatenation type of this mailing.
getFilterId (line 637)
  • access: public
void getFilterId ()

Implementation of:
Inx_Api_Mailing_Mailing::getFilterId()
Returns a sending filter of this mailing.
getFilterIds (line 662)
  • access: public
void getFilterIds ()

Implementation of:
Inx_Api_Mailing_Mailing::getFilterIds()
Returns the sending filter of this mailing.
getId (line 512)

Enter description here.

Enter description here...

  • access: public
int getId ()

Implementation of:
Inx_Api_BusinessObject::getId()
Returns the unique identifier of this Inx_Api_BusinessObject.
getListContextId (line 600)
  • access: public
void getListContextId ()

Implementation of:
Inx_Api_Mailing_Mailing::getListContextId()
Returns the id of list context which this mailing belongs to.
getLockTicket (line 542)

Enter description here.

Enter description here...

  • access: public
Inx_Api_LockTicket getLockTicket ()

Implementation of:
Inx_Api_Mailing_Mailing::getLockTicket()
Returns the lock ticket.
getModificationDatetime (line 552)

Enter description here.

Enter description here...

  • access: public
Date getModificationDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getModificationDatetime()
Returns the last modification datetime.
getName (line 697)
  • access: public
void getName ()

Implementation of:
Inx_Api_Mailing_Mailing::getName()
Returns the name of this mailing.
getPriority (line 783)

Enter description here.

Enter description here...

  • access: public
Integer getPriority ()

Implementation of:
Inx_Api_Mailing_Mailing::getPriority()
Returns the value of X-Priority header.
getRecipientAddress (line 740)
  • access: public
void getRecipientAddress ()

Implementation of:
Inx_Api_Mailing_Mailing::getRecipientAddress()
Returns the recipient address of this mailing.
getReplyToAddress (line 759)
  • access: public
void getReplyToAddress ()

Implementation of:
Inx_Api_Mailing_Mailing::getReplyToAddress()
Returns the recipient address of this mailing.
getScheduleDatetime (line 557)
  • access: public
void getScheduleDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getScheduleDatetime()
Returns the schedule datetime.
getSenderAddress (line 721)

Enter description here.

Enter description here...

  • access: public
String getSenderAddress ()

Implementation of:
Inx_Api_Mailing_Mailing::getSenderAddress()
Returns the sender address of this mailing.
getSendingInfo (line 242)
  • access: public
void getSendingInfo ()

Implementation of:
Inx_Api_Mailing_Mailing::getSendingInfo()
Returns the mailing info object which contains the number sent mails.
getSentDatetime (line 579)

Enter description here.

Enter description here...

  • access: public
Date getSentDatetime ()

Implementation of:
Inx_Api_Mailing_Mailing::getSentDatetime()
Returns the sent datetime, null if this mailing not yet sent.
getState (line 522)

Enter description here.

Enter description here...

  • access: public
int getState ()

Implementation of:
Inx_Api_Mailing_Mailing::getState()
Returns the mailing state.
getSubject (line 680)
  • access: public
void getSubject ()

Implementation of:
Inx_Api_Mailing_Mailing::getSubject()
Returns the subject of this mailing.
isLocked (line 532)

Enter description here.

Enter description here...

  • access: public
boolean isLocked ()

Implementation of:
Inx_Api_Mailing_Mailing::isLocked()
Checks if this mailing has a lock.
lock (line 465)

Enter description here.

Enter description here...

  • throws: Inx_Api_Mailing_MailingStateException, LockException, Inx_Api_DataException
  • access: public
void lock ()

Implementation of:
Inx_Api_Mailing_Mailing::lock()
Lock the this Inx_Api_Mailing_Mailing.
refreshData (line 963)

Enter description here.

Enter description here...

  • throws: Inx_Api_DataException
  • access: protected
void refreshData ( $oData)
  • stdClass $oData
reload (line 876)
  • throws: Inx_Api_DataException
  • access: public
void reload ()

Implementation of:
Inx_Api_BusinessObject::reload()
Reloads this business object from the server.
requestApproval (line 359)

Enter description here.

Enter description here...

  • throws: Inx_Api_Mailing_MailingStateException, Inx_Api_DataException
  • access: public
void requestApproval ()

Implementation of:
Inx_Api_Mailing_Mailing::requestApproval()
Request the approval for this mailing.
requestEscalationApproval (line 311)
  • access: public
void requestEscalationApproval ( $escalationDate,  $deadline,  $approverIds,  $recipientIds,  $isTestRecipient,  $locale)
  • $escalationDate
  • $deadline
  • $approverIds
  • $recipientIds
  • $isTestRecipient
  • $locale

Implementation of:
Inx_Api_Mailing_Mailing::requestEscalationApproval()
Request the escalating approval for this mailing.
requestIdenticalApproval (line 319)
  • access: public
void requestIdenticalApproval ( $deadline,  $approverIds,  $recipientIds,  $isTestRecipient,  $locale)
  • $deadline
  • $approverIds
  • $recipientIds
  • $isTestRecipient
  • $locale

Implementation of:
Inx_Api_Mailing_Mailing::requestIdenticalApproval()
Request the escalating approval for this mailing.
revokeApproval (line 365)
  • access: public
void revokeApproval ([ $comment = null])
  • $comment

Implementation of:
Inx_Api_Mailing_Mailing::revokeApproval()
Revoke the approval or scheduling for this mailing.
scheduleMailing (line 392)
  • access: public
void scheduleMailing ([ $scheduleTime = null])
  • $scheduleTime

Implementation of:
Inx_Api_Mailing_Mailing::scheduleMailing()
Schedules the mailing with the given date.
sendSingleMail (line 163)

Enter description here.

Enter description here...

  • throws: Inx_Api_Mailing_SendException, Inx_Api_Mailing_MailingStateException, Inx_Api_DataException
  • access: public
void sendSingleMail (int $iRecipientId)
  • int $iRecipientId

Implementation of:
Inx_Api_Mailing_Mailing::sendSingleMail()
Sending this mailing to the specified recipient. to generating the email content.
sendTestMail (line 94)

Enter description here.

Enter description here...

  • throws: SendException, Inx_Api_Mailing_MailingStateException, Inx_Api_DataException
  • access: public
null sendTestMail (string $sTestAddress, int $iRecipientId)
  • string $sTestAddress
  • int $iRecipientId

Implementation of:
Inx_Api_Mailing_Mailing::sendTestMail()
Sending this mailing to the test address. to generating the email content.
sendTestMailWithTestprofile (line 126)
  • access: public
void sendTestMailWithTestprofile ( $sTestAddress,  $iTestprofileId)
  • $sTestAddress
  • $iTestprofileId

Implementation of:
Inx_Api_Mailing_Mailing::sendTestMailWithTestprofile()
Sending this mailing to the test address. to generating the email content.
setContentHandler (line 822)

Enter description here.

Enter description here...

  • access: public
void setContentHandler (string $sContentHandlerClazz)
  • string $sContentHandlerClazz

Implementation of:
Inx_Api_Mailing_Mailing::setContentHandler()
Creates a new content handler.
startSending (line 197)

Enter description here.

Enter description here...

  • throws: Inx_Api_Mailing_MailingStateException, Inx_Api_DataException
  • access: public
void startSending ()

Implementation of:
Inx_Api_Mailing_Mailing::startSending()
Start or restart the sending of this mailing.
stopSending (line 221)
  • throws: Inx_Api_Mailing_MailingStateException, Inx_Api_DataException
  • access: public
void stopSending ()

Implementation of:
Inx_Api_Mailing_Mailing::stopSending()
Stop the sending of the specified mailing.
unlock (line 491)

Enter description here.

Enter description here...

  • throws: Inx_Api_DataException
  • access: public
unknown unlock ([boolean $blForceForeignLock = false])
  • boolean $blForceForeignLock

Implementation of:
Inx_Api_Mailing_Mailing::unlock()
Release the lock of this Inx_Api_Mailing_Mailing.
unscheduleMailing (line 420)
  • access: public
void unscheduleMailing ()

Implementation of:
Inx_Api_Mailing_Mailing::unscheduleMailing()
Unschedules the mailing.
updateFilterId (line 645)
  • access: public
void updateFilterId ( $iFilterId)
  • $iFilterId

Implementation of:
Inx_Api_Mailing_Mailing::updateFilterId()
Sets a sending filter of this mailing.
updateFilterIds (line 671)
  • access: public
void updateFilterIds ( $filterIds,  $concatinationType)
  • $filterIds
  • $concatinationType

Implementation of:
Inx_Api_Mailing_Mailing::updateFilterIds()
Sets a couple of sending filter to this mailing.
updateName (line 707)

Enter description here.

Enter description here...

  • access: public
void updateName (String $sName)
  • String $sName

Implementation of:
Inx_Api_Mailing_Mailing::updateName()
Sets the name of this mailing.
updatePriority (line 794)

Enter description here.

Enter description here...

  • access: public
void updatePriority (Integer $iPriority)
  • Integer $iPriority

Implementation of:
Inx_Api_Mailing_Mailing::updatePriority()
Sets the value of X-Priority header.
updateRecipientAddress (line 751)

Enter description here.

Enter description here...

  • access: public
void updateRecipientAddress (String $sRecipientAddress)
  • String $sRecipientAddress

Implementation of:
Inx_Api_Mailing_Mailing::updateRecipientAddress()
Sets the recipient address of this mailing.
updateReplyToAddress (line 770)

Enter description here.

Enter description here...

  • access: public
void updateReplyToAddress (String $sReplyToAddress)
  • String $sReplyToAddress

Implementation of:
Inx_Api_Mailing_Mailing::updateReplyToAddress()
Sets the replyTo address of this mailing.
updateScheduleDatetime (line 567)

Enter description here.

Enter description here...

  • access: public
void updateScheduleDatetime (Date $dtScheduleDatetime)
  • Date $dtScheduleDatetime

Implementation of:
Inx_Api_Mailing_Mailing::updateScheduleDatetime()
Sets the schedule datetime.
updateSenderAddress (line 732)

Enter description here.

Enter description here...

  • access: public
void updateSenderAddress (String $sSenderAddress)
  • String $sSenderAddress

Implementation of:
Inx_Api_Mailing_Mailing::updateSenderAddress()
Sets the sender address of this mailing.
updateSubject (line 690)

Enter description here.

Enter description here...

  • access: public
void updateSubject (String $sSubject)
  • String $sSubject

Implementation of:
Inx_Api_Mailing_Mailing::updateSubject()
Sets the subject of this mailing.

Documentation generated on Thu, 17 Sep 2015 14:27:27 +0200 by phpDocumentor 1.3.2