Class lispa\amos\emailmanager\AmosEmail

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\emailmanager\AmosEmail » lispa\amos\core\module\AmosModule » lispa\amos\core\module\BaseAmosModule » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object
Implements	lispa\amos\core\module\ModuleInterface, yii\base\BootstrapInterface, yii\base\Configurable

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$aliases	array	List of path aliases to be defined.	yii\base\Module
$amosUniqueId	string		lispa\amos\core\module\BaseAmosModule
$basePath	string	The root directory of the module.	yii\base\Module
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$components	array	The list of the component definitions or the loaded component instances (ID => definition or instance).	yii\di\ServiceLocator
$controllerMap	array	Mapping from controller ID to controller configurations.	yii\base\Module
$controllerNamespace			lispa\amos\emailmanager\AmosEmail
$controllerPath	string	The directory that contains the controller classes.	yii\base\Module
$defaultLayout			lispa\amos\emailmanager\AmosEmail
$defaultListViews	array	This set the default views in lists	lispa\amos\core\module\AmosModule
$defaultRoute	string	The default route of this module.	yii\base\Module
$defaultTemplate	string	The default layout to use for template emails.	lispa\amos\emailmanager\AmosEmail
$i18nDirPath	string		lispa\amos\core\module\AmosModule
$id	string	An ID that uniquely identifies this module among other modules which have the same parent.	yii\base\Module
$layout	string\|boolean	The layout that should be applied for views within this module.	yii\base\Module
$layoutPath	string	The root directory of layout files.	yii\base\Module
$modelMap	array		lispa\amos\core\module\AmosModule
$module	yii\base\Module	The parent module of this module.	yii\base\Module
$moduleId			lispa\amos\emailmanager\AmosEmail
$modules	array	The modules (indexed by their IDs).	yii\base\Module
$name			lispa\amos\emailmanager\AmosEmail
$params	array	Custom module parameters (name => value).	yii\base\Module
$rbacEnabled	boolean		lispa\amos\core\module\BaseAmosModule
$templatePath			lispa\amos\emailmanager\AmosEmail
$templateType	string	Template type, can be "db" or "php".	lispa\amos\emailmanager\AmosEmail
$uniqueId	string	The unique ID of the module.	yii\base\Module
$version	string	The version of this module.	yii\base\Module
$viewPath	string	The root directory of view files.	yii\base\Module
$widgetGraphics			lispa\amos\emailmanager\AmosEmail
$widgetIcons			lispa\amos\emailmanager\AmosEmail

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Module
__get()	Getter magic method.	yii\di\ServiceLocator
__isset()	Checks if a property value is null.	yii\di\ServiceLocator
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
afterAction()	This method is invoked right after an action within this module is executed.	yii\base\Module
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()	This method is invoked right before an action within this module is executed.	yii\base\Module
beginCreateNewSessionKey()	This method return the session key that must be used to add in session the url from the user have started the content creation.	lispa\amos\core\module\AmosModule
beginCreateNewSessionKeyDateTime()	This method return the session key that must be used to add in session the url date and time creation from the user have started the content creation.	lispa\amos\core\module\AmosModule
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
bootstrap()		lispa\amos\emailmanager\AmosEmail
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\Object
clear()	Removes the component from the locator.	yii\di\ServiceLocator
createController()	Creates a controller instance based on the given route.	yii\base\Module
createControllerByID()	Creates a controller based on the given controller ID.	yii\base\Module
createModel()		lispa\amos\core\module\AmosModule
defineModelClasses()	Merges the default and user defined model classes Also let's the developer to set new ones with the parameter being those the ones with most preference.	lispa\amos\core\module\AmosModule
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
get()	Returns the component instance with the specified ID.	yii\di\ServiceLocator
getAmosUniqueId()		lispa\amos\core\module\BaseAmosModule
getBasePath()	Returns the root directory of the module.	yii\base\Module
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getComponents()	Returns the list of the component definitions or the loaded component instances.	yii\di\ServiceLocator
getControllerPath()	Returns the directory that contains the controller classes according to $controllerNamespace.	yii\base\Module
getI18nDirPath()		lispa\amos\core\module\AmosModule
getInstance()	Returns the currently requested instance of this module class.	yii\base\Module
getLayoutPath()	Returns the directory that contains layout view files for this module.	yii\base\Module
getModule()	Retrieves the child module of the specified ID.	yii\base\Module
getModuleName()		lispa\amos\emailmanager\AmosEmail
getModules()	Returns the sub-modules in this module.	yii\base\Module
getRbacEnabled()		lispa\amos\core\module\BaseAmosModule
getUniqueId()	Returns an ID that uniquely identifies this module among all modules within the current application.	yii\base\Module
getVersion()	Returns current module version.	yii\base\Module
getViewPath()	Returns the directory that contains the view files for this module.	yii\base\Module
getWidgetGraphics()		lispa\amos\emailmanager\AmosEmail
getWidgetIcons()		lispa\amos\emailmanager\AmosEmail
has()	Returns a value indicating whether the locator has the specified component definition or has instantiated the component.	yii\di\ServiceLocator
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasModule()	Checks whether the child module of the specified ID exists.	yii\base\Module
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()		lispa\amos\emailmanager\AmosEmail
instance()	Return an instance of module	lispa\amos\core\module\AmosModule
model()	Get defined className of model	lispa\amos\core\module\AmosModule
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
queue()	Sends email message queue using default transport	lispa\amos\emailmanager\AmosEmail
runAction()	Runs a controller action specified by a route.	yii\base\Module
send()	Sends email message immediately using default transport	lispa\amos\emailmanager\AmosEmail
set()	Registers a component definition with this locator.	yii\di\ServiceLocator
setAliases()	Defines path aliases.	yii\base\Module
setBasePath()	Sets the root directory of the module.	yii\base\Module
setComponents()	Registers a set of component definitions in this locator.	yii\di\ServiceLocator
setInstance()	Sets the currently requested instance of this module class.	yii\base\Module
setLayoutPath()	Sets the directory that contains the layout files.	yii\base\Module
setModule()	Adds a sub-module to this module.	yii\base\Module
setModules()	Registers sub-modules in the current module.	yii\base\Module
setRbacEnabled()		lispa\amos\core\module\BaseAmosModule
setVersion()	Sets current module version.	yii\base\Module
setViewPath()	Sets the directory that contains the view files.	yii\base\Module
spool()		lispa\amos\emailmanager\AmosEmail
t()		lispa\amos\core\module\BaseAmosModule
tHtml()	Metodo da usare per tutte le traduzioni che non fanno parte di attributi dei tag html (es. Non si può usare nell'attributo "title" del tag "a")	lispa\amos\core\module\BaseAmosModule
tOld()	Metodo vecchio stile com'era nei plugin prima di introdurre le traduzioni a db.	lispa\amos\core\module\BaseAmosModule
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
defaultVersion()	Returns default module version.	yii\base\Module
getDefaultModels()		lispa\amos\emailmanager\AmosEmail

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised after executing a controller action.	yii\base\Module
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised before executing a controller action.	yii\base\Module

Property Details

$controllerNamespace public property

public $controllerNamespace = 'lispa\amos\emailmanager\controllers'

$defaultLayout public property

public $defaultLayout = "layout_fancy"

$defaultTemplate public property

The default layout to use for template emails.

public string $defaultTemplate = "layout_default"

$moduleId public static property

public static $moduleId = 'email'

$name public property

public $name = 'Email manager'

$templatePath public property

public $templatePath = "/emails/"

$templateType public property

Template type, can be "db" or "php".

public string $templateType = "php"

$widgetGraphics public read-only property

public void getWidgetGraphics ( )

$widgetIcons public read-only property

public void getWidgetIcons ( )

Method Details

bootstrap() public method

public void bootstrap ( $app )
$app	yii\console\Application

getDefaultModels() protected method

public void queue ( $from, $to, $subject, $text, $files = [], $bcc = [], $params = [], $priority = 0 )
$from	string	Format accepted: 1) 'example@example.com' 2) 'example@example.com alias' the method considers the email address up to the first space, everything that follows is considered alias.
$to	string
$subject	string
$text	string
$files	array
$bcc	array
$params
$priority	integer

public boolean send ( $from, $to, $subject, $text, $files = [], $bcc = [], $params = [], $save_in_queue = true )
$from	string	Format accepted: 1) 'example@example.com' 2) 'example@example.com alias' the method considers the email address up to the first space, everything that follows is considered alias.
$to	string
$subject	string
$text	string
$files	array
$bcc	array
$params
$save_in_queue

public integer spool ( $loopLimit = 1000 )
$loopLimit	integer