Documentation

SendEmail extends BaseAction
in package

SendEmail class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : mixed
{@inheritdoc}
$controller  : Controller
$responseType  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
post()  : array<string|int, mixed>
Send e-mail.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
Check permission to module.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = []

Allowed headers

$allowedMethod

{@inheritdoc}

public mixed $allowedMethod = ['POST']

$responseType

public string $responseType = 'data'

Response data type.

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

post()

Send e-mail.

public post() : array<string|int, mixed>
Tags
throws
Exception
OA\Post

( path="/webservice/ManageConsents/{moduleName}/SendEmail", summary="Send e-mail", tags={"BaseModule"}, security={ {"basicAuth" : }, "ApiKeyAuth" : }, "token" : }} }, @OA\RequestBody( required=true, description="Required data for communication", @OA\JsonContent(ref="#/components/schemas/BaseModule_Post_SendEmail_Request"), @OA\MediaType( mediaType="multipart/form-data", @OA\Schema(ref="#/components/schemas/BaseModule_Post_SendEmail_Request") ), @OA\MediaType( mediaType="application/x-www-form-urlencoded", @OA\Schema(ref="#/components/schemas/BaseModule_Post_SendEmail_Request") ), ), @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"), @OA\Response( response=200, description="Status of adding an email to the queue", @OA\JsonContent(ref="#/components/schemas/BaseModule_Post_SendEmail_Response"), ), @OA\Response( response=401, description="No sent token OR Invalid token", ), @OA\Response( response=403, description="No permissions for module", ), @OA\Response( response=404, description="Not Found", ), @OA\Response( response=405, description="Method Not Allowed", ), ),

OA\Schema

( schema="BaseModule_Post_SendEmail_Request", title="Request body for SendEmail", type="object", @OA\Property( property="e-mail", description="E-mail address (Token type field in the module is required)", type="string" ), @OA\Property( property="templateId", description="Specific ID of the email template", type="integer" ), ),

OA\Schema

( schema="BaseModule_Post_SendEmail_Response", title="Response body for SendEmail", type="object", @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property( property="result", description="Added mail to quote for send: true - success , false - fail", type="boolean", example=true ), ),

Return values
array<string|int, mixed> —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Tags
throws
Exception
Return values
void —

checkPermissionToModule()

Check permission to module.

protected checkPermissionToModule() : void
Tags
throws
Exception
Return values
void —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results