\Oxws_Email

Functions related to emails

Summary

Methods
Properties
Constants
getConfig()
getDb()
requestModule()
fetchThankyouNotes()
fetchRatingRequestTemplates()
fetchTemplateById()
updateShopManagerTemplate()
deleteShopManagerTemplate()
sendThankyouNote()
sendRatingRequest()
No public properties found
No constants found
No protected methods found
$myConfig
$oDb
$eBody
$eSubject
N/A
No private methods found
No private properties found
N/A

Properties

$myConfig

$myConfig : object

Config object

Type

object

$oDb

$oDb : object

Database object

Type

object

$eBody

$eBody : string

Content for the email sending for module request

Type

string

$eSubject

$eSubject : string

Subject for the email sending for module request

Type

string

Methods

getConfig()

getConfig() : object

Function to get config object

Returns

object

getDb()

getDb() : object

Function to get database object

Returns

object

requestModule()

requestModule(string  $emailid) : null

Function to send shopmanager module to the customer through email.

Parameters

string $emailid

email address of the user

Returns

null

fetchThankyouNotes()

fetchThankyouNotes() : array

Function to fetch order thankyou email templates

Returns

array

fetchRatingRequestTemplates()

fetchRatingRequestTemplates() : array

Function to fetch rating request email templates

Returns

array

fetchTemplateById()

fetchTemplateById(string  $templateId) : array

Function to fetch email template based on oxid of the template

Parameters

string $templateId

oxid of the template

Returns

array

updateShopManagerTemplate()

updateShopManagerTemplate(array  $data) : boolean

Function to update email template related to shopmanager based on oxid of the template

Parameters

array $data

json array with 'templateTitle'=>title of the template to be edited, 'templateId'=>oxid of the template to be edited 'templateContent'=> template content

Returns

boolean

deleteShopManagerTemplate()

deleteShopManagerTemplate(string  $templateId) : string

Function to delete email template related to shopmanager based on oxid of the template

Parameters

string $templateId

oxid of the template

Returns

string

sendThankyouNote()

sendThankyouNote(array  $data) : string

Function to send thankyou email template to the user

Parameters

array $data

json array with 'eSubject' => subject of the email template to be sent, 'eBody' => content of the email template to be sent, 'eMailid' => email id of the user, 'orderId' => oxid of the order

Returns

string

sendRatingRequest()

sendRatingRequest(array  $data) : string

Function to send rating request email template to the user

Parameters

array $data

json array with 'eSubject' => subject of the email template to be sent, 'eBody' => content of the email template to be sent, 'eMailid' => email id of the user, 'orderId' => oxid of the order

Returns

string