Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • ActionFormModel
  • ArrayUtil
  • ArrayValidator
  • AssociatedMediaBehavior
  • AuxLib
  • Changelog
  • DetailView
  • EncryptUtilTmp
  • EventsWidgetFieldFormatter
  • FailedLogins
  • FieldFormatter
  • FieldFormatterBase
  • FieldInputRenderer
  • FileFieldBehavior
  • FiltersForm
  • FilterUtil
  • FineDiff
  • FineDiffCopyOp
  • FineDiffDeleteOp
  • FineDiffInsertOp
  • FineDiffOp
  • FineDiffOps
  • FineDiffReplaceOp
  • GlobalCSSFormModel
  • GlobalImportFormModel
  • GoogleAuthenticator
  • JSONFieldsBehavior
  • JSONResponse
  • MediaFieldFormatter
  • MediaSelector
  • MobileActiveRecordFieldFormatter
  • MobileActivityFeed
  • MobileChartDashboard
  • MobileFieldFormatter
  • MobileFieldInputRenderer
  • ModuleModelNameValidator
  • MultiChildNode
  • MultiTypeAutocomplete
  • PasswordUtil
  • ProductFeature
  • ProfileWidgetLayout
  • QueryParamGenerator
  • RecordLimitBehavior
  • RecordView
  • RecordViewWidgetLayout
  • RelationshipsGridModel
  • RelationshipsJoin
  • RepairUserDataCommand
  • RequestUtil
  • RequiredIfNotSetValidator
  • ResponseUtil
  • RunMigrationScriptCommand
  • ServiceWebFormDesigner
  • Settings
  • StringUtil
  • TestEmailAction
  • TestEmailActionForm
  • ThemeGenerator
  • TimerUtil
  • TopicsFieldFormatter
  • TopicsWidgetLayout
  • TransactionalViewFieldFormatter
  • UrlUtil
  • ValidLinkValidator
  • WebFormDesigner
  • WebLeadFormDesigner
  • X2ActiveRecordBehavior
  • X2ActiveRecordFieldFormatter
  • X2ButtonColumn
  • X2ConditionList
  • X2ConsoleCommand
  • X2ControllerBehavior
  • X2DataColumn
  • X2DuplicateBehavior
  • X2Flashes
  • X2GridViewFieldFormatter
  • X2IPAddress
  • X2LeadsDataColumn
  • X2MergeableBehavior
  • X2MessageSource
  • X2MobileControllerBehavior
  • X2MobileProfileControllerBehavior
  • X2MobileQuotesControllerBehavior
  • X2MobileSiteControllerBehavior
  • X2MobileTopicsControllerBehavior
  • X2ModelConversionBehavior
  • X2ModelConversionWidget
  • X2ModelForeignKeyValidator
  • X2ModelUniqueIndexValidator
  • X2NonWebUser
  • X2StaticDropdown
  • X2StaticField
  • X2StaticFieldsBehavior
  • X2UrlManager
  • X2Validator
  • X2WidgetBehavior

Interfaces

  • AdminOwnedCredentials

Exceptions

  • CampaignMailingException
  • CodeExchangeException
  • GetCredentialsException
  • NoRefreshTokenException
  • NoUserIdException
  • StringUtilException

Functions

  • checkCurrency
  • checkDNS
  • checkServerVar
  • checkTimezone
  • decodeQuotes
  • echoIcons
  • encodeQuotes
  • exceptionForError
  • getField
  • getLanguageName
  • getModuleTitle
  • handleReqError
  • handleReqException
  • installer_t
  • installer_tr
  • isAllowedDir
  • mediaMigrationRrmdir
  • migrateMediaDir
  • printGraph
  • printR
  • renderFields
  • reqShutdown
  • RIP
  • translateOptions
  • tryGetRemote
  • Overview
  • Package
  • Class
  • Tree
  1: <?php
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address contact@x2engine.com.
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * Simulates campaign email delivery 
 39:  */
 40: 
 41: class TestEmailAction extends CAction {
 42: 
 43:     public function getBehaviors(){
 44:         return array(
 45:             'CampaignMailingBehavior' => array(
 46:                 'class' => 'application.modules.marketing.components.CampaignMailingBehavior'
 47:             ),
 48:             'responds' => array(
 49:                 'class' => 'application.components.ResponseBehavior',
 50:                 'errorCode' => 200
 51:             ),
 52:         );
 53:     }
 54: 
 55:     public function run(){
 56:         if (Yii::app()->user->isGuest) {
 57:             Yii::app()->controller->redirect(Yii::app()->controller->createUrl('/site/login'));
 58:         }
 59: 
 60:         $this->attachBehaviors($this->behaviors);
 61:         // Safety net of handlers - they ensure that errors can be caught and seen easily:
 62: 
 63:         $scenario = 'custom';
 64:         $model = new TestEmailActionForm ();
 65:         $model->contactFlag = true;
 66:         $model->setScenario($scenario);
 67:         if(!isset($_POST['InlineEmail'])){
 68:             throw new CHttpException (400, Yii::t('marketing', 'Bad request'));
 69:         }
 70: 
 71:         $model->attributes = $_POST['InlineEmail'];
 72:         $responseMessage = '';
 73:         $sendStatus = array_fill_keys(array('code','message'),'');
 74:         $failed = false;
 75:         if ($model->validate ()) {
 76:             $model->campaign->content = $model->message;
 77:             $model->campaign->sendAs = $model->credId;
 78:             $this->asa ('CampaignMailingBehavior')->setCampaign ($model->campaign);
 79:             list($subject,$message,$uniqueId) = 
 80:                 self::prepareEmail ($model->campaign, $model->getTargetModel ());
 81: 
 82:             $this->deliverEmail ($model->mailingList, $model->subject, $message);
 83:             $sendStatus['code'] = $this->asa ('CampaignMailingBehavior')->status['code'];
 84:             $sendStatus['message'] = $this->asa ('CampaignMailingBehavior')->status['message'];
 85:             if ($this->asa ('CampaignMailingBehavior')->status['code'] == 200) {
 86:                 $responseMessage = Yii::t(
 87:                     'marketing','Test email sent successfully to {address}.',
 88:                     array('{address}' => $model->to));
 89:             } else {
 90:                 $responseMessage = Yii::t(
 91:                     'marketing','Test email sent could not be sent to {address}.',
 92:                     array('{address}' => $model->to));
 93:                 $failed = true;
 94:             }
 95:         }
 96: 
 97:         // Populate response data:
 98:         $modelHasErrors = $model->hasErrors();
 99:         $failed = $failed || $modelHasErrors;
100:         $model->attachments = array (); // prevent response json encoding failures
101:         $response = array(
102:             'scenario' => $scenario,
103:             'sendStatus' => $sendStatus,
104:             'attributes' => $model->attributes,
105:             'modelErrors' => $model->errors,
106:             'failed' => $failed,
107:             'modelHasErrors' => $modelHasErrors,
108:             'modelErrorHtml' => CHtml::errorSummary(
109:                 $model,Yii::t('app', "Please fix the following errors:"),
110:                 null,
111:                 array('style'=>'margin-bottom: 5px;', 'class' => '')),
112:         );
113:         $this->mergeResponse($response);
114:         $this->respond($responseMessage,$failed);
115:     }
116: }
117: 
118: /**
119:  * Adds test campaign-specific fields to InlineEmail
120:  */
121: 
122: class TestEmailActionForm extends InlineEmail {
123:     public $campaignId;
124:     public $campaign;
125:     public $modelName = 'Contacts';
126:     public $recordName;
127: 
128:     public function rules () {
129:         return array_merge (parent::rules (), array (
130:             array (
131:                 'campaignId', 'required'
132:             ),
133:             array (
134:                 'modelName', 'required'
135:             ),
136:             array (
137:                 'recordName', 'safe'
138:             ),
139:             array (
140:                 'modelName', 'validateModelName'
141:             ),
142:             array (
143:                 'campaignId', 'validateCampaignId'
144:             ),
145:         ));
146:     }
147: 
148:     /**
149:      * Allow for record name lookup, in addition to default id lookup
150:      */
151:     public function validateModelName ($attr) {
152:         $value = $this->$attr;
153:         $contact = null;
154:         if (isset ($this->modelId) && is_numeric ($this->modelId)) {
155:             $contact = Contacts::model ()->findByPk ($this->modelId);
156:         } else if (isset ($this->recordName)) {
157:             $contact = Contacts::model ()->findByAttributes (array (
158:                 'name' => $this->recordName
159:             ));
160:         }
161:         if (!$contact) $this->addError ($attr, Yii::t('app', 'Contact not found'));
162:         else $this->setTargetModel ($contact);
163:     }
164: 
165:     public function validateCampaignId ($attr) {
166:         $value = $this->$attr;
167:         $campaign = Campaign::model ()->findByPk ($value);
168:         if (!$campaign) {
169:             throw new CHttpException (400, Yii::t('marketing', 'Bad request'));
170:         }
171:         $this->campaign = $campaign;
172:     }
173: }
174: 
175: ?>
176: 
X2CRM Documentation API documentation generated by ApiGen 2.8.0