urembo-hub-api
Preparing search index...
email/email.service
EmailService
Class EmailService
Index
Constructors
constructor
Methods
get
Status
is
Available
send
Account
Created
Email
send
Admin
Cart
Notification
Email
send
Admin
Sale
Notification
Email
send
Admin
Signup
Notification
Email
send
Admin
Ticket
Notification
Email
send
Booking
Confirmed
Client
Email
send
Booking
Confirmed
Vendor
Email
send
Booking
Reminder
Email
send
Dispute
Pending
Email
send
Email
send
High
Value
Order
Email
send
Kyc
Update
Email
send
New
Order
Email
send
Order
Accepted
Email
send
Order
Delivered
Email
send
Order
Shipped
Email
send
Partner
Approval
Email
send
Partner
Signup
Notification
Email
send
Password
Changed
Email
send
Password
Reset
Email
send
Password
Reset
OTP
Email
send
Payment
Failed
Email
send
Payment
Missing
Email
send
Payment
Successful
Email
send
Profile
Approved
Email
send
Profile
Rejected
Email
send
Suspicious
Login
Email
send
Verification
Email
send
Welcome
Email
Constructors
constructor
new
EmailService
(
configService
:
ConfigService
)
:
EmailService
Parameters
configService
:
ConfigService
Returns
EmailService
Methods
get
Status
getStatus
()
:
{
available
:
boolean
;
reason
?:
string
}
Get the status of the email service
Returns
{
available
:
boolean
;
reason
?:
string
}
is
Available
isAvailable
()
:
boolean
Check if the email service is available
Returns
boolean
send
Account
Created
Email
sendAccountCreatedEmail
(
userEmail
:
string
,
userName
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Admin
Cart
Notification
Email
sendAdminCartNotificationEmail
(
adminEmail
:
string
,
cartData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
cartData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Admin
Sale
Notification
Email
sendAdminSaleNotificationEmail
(
adminEmail
:
string
,
saleData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
saleData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Admin
Signup
Notification
Email
sendAdminSignupNotificationEmail
(
adminEmail
:
string
,
userData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
userData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Admin
Ticket
Notification
Email
sendAdminTicketNotificationEmail
(
adminEmail
:
string
,
ticketData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
ticketData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Booking
Confirmed
Client
Email
sendBookingConfirmedClientEmail
(
clientEmail
:
string
,
clientName
:
string
,
bookingData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
clientEmail
:
string
clientName
:
string
bookingData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Booking
Confirmed
Vendor
Email
sendBookingConfirmedVendorEmail
(
vendorEmail
:
string
,
vendorName
:
string
,
bookingData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
vendorEmail
:
string
vendorName
:
string
bookingData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Booking
Reminder
Email
sendBookingReminderEmail
(
clientEmail
:
string
,
clientName
:
string
,
bookingData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
clientEmail
:
string
clientName
:
string
bookingData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Dispute
Pending
Email
sendDisputePendingEmail
(
adminEmail
:
string
,
disputeId
:
string
,
disputeData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
disputeId
:
string
disputeData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Email
sendEmail
(
options
:
SendEmailOptions
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
options
:
SendEmailOptions
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
High
Value
Order
Email
sendHighValueOrderEmail
(
adminEmail
:
string
,
orderId
:
string
,
orderData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
adminEmail
:
string
orderId
:
string
orderData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Kyc
Update
Email
sendKycUpdateEmail
(
userEmail
:
string
,
userName
:
string
,
status
:
string
,
reason
?:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
status
:
string
Optional
reason
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
New
Order
Email
sendNewOrderEmail
(
vendorEmail
:
string
,
vendorName
:
string
,
orderId
:
string
,
orderData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
vendorEmail
:
string
vendorName
:
string
orderId
:
string
orderData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Order
Accepted
Email
sendOrderAcceptedEmail
(
customerEmail
:
string
,
customerName
:
string
,
orderId
:
string
,
orderData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
customerEmail
:
string
customerName
:
string
orderId
:
string
orderData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Order
Delivered
Email
sendOrderDeliveredEmail
(
customerEmail
:
string
,
customerName
:
string
,
orderId
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
customerEmail
:
string
customerName
:
string
orderId
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Order
Shipped
Email
sendOrderShippedEmail
(
customerEmail
:
string
,
customerName
:
string
,
orderId
:
string
,
trackingNumber
?:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
customerEmail
:
string
customerName
:
string
orderId
:
string
Optional
trackingNumber
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Partner
Approval
Email
sendPartnerApprovalEmail
(
partnerEmail
:
string
,
partnerName
:
string
,
approved
:
boolean
,
reason
?:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
partnerEmail
:
string
partnerName
:
string
approved
:
boolean
Optional
reason
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Partner
Signup
Notification
Email
sendPartnerSignupNotificationEmail
(
partnerEmail
:
string
,
partnerName
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
partnerEmail
:
string
partnerName
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Password
Changed
Email
sendPasswordChangedEmail
(
userEmail
:
string
,
userName
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Password
Reset
Email
sendPasswordResetEmail
(
userEmail
:
string
,
userName
:
string
,
resetUrl
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
resetUrl
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Password
Reset
OTP
Email
sendPasswordResetOTPEmail
(
userEmail
:
string
,
userName
:
string
,
otp
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
otp
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Payment
Failed
Email
sendPaymentFailedEmail
(
userEmail
:
string
,
userName
:
string
,
paymentData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
paymentData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Payment
Missing
Email
sendPaymentMissingEmail
(
userEmail
:
string
,
userName
:
string
,
setupUrl
?:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
Optional
setupUrl
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Payment
Successful
Email
sendPaymentSuccessfulEmail
(
userEmail
:
string
,
userName
:
string
,
paymentData
:
any
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
paymentData
:
any
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Profile
Approved
Email
sendProfileApprovedEmail
(
userEmail
:
string
,
userName
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Profile
Rejected
Email
sendProfileRejectedEmail
(
userEmail
:
string
,
userName
:
string
,
reason
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
reason
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Suspicious
Login
Email
sendSuspiciousLoginEmail
(
userEmail
:
string
,
userName
:
string
,
loginIp
:
string
,
location
?:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
loginIp
:
string
Optional
location
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Verification
Email
sendVerificationEmail
(
userEmail
:
string
,
userName
:
string
,
verificationUrl
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
verificationUrl
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
send
Welcome
Email
sendWelcomeEmail
(
userEmail
:
string
,
userName
:
string
,
)
:
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Parameters
userEmail
:
string
userName
:
string
Returns
Promise
<
{
error
?:
string
;
messageId
?:
string
;
success
:
boolean
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Status
is
Available
send
Account
Created
Email
send
Admin
Cart
Notification
Email
send
Admin
Sale
Notification
Email
send
Admin
Signup
Notification
Email
send
Admin
Ticket
Notification
Email
send
Booking
Confirmed
Client
Email
send
Booking
Confirmed
Vendor
Email
send
Booking
Reminder
Email
send
Dispute
Pending
Email
send
Email
send
High
Value
Order
Email
send
Kyc
Update
Email
send
New
Order
Email
send
Order
Accepted
Email
send
Order
Delivered
Email
send
Order
Shipped
Email
send
Partner
Approval
Email
send
Partner
Signup
Notification
Email
send
Password
Changed
Email
send
Password
Reset
Email
send
Password
Reset
OTP
Email
send
Payment
Failed
Email
send
Payment
Missing
Email
send
Payment
Successful
Email
send
Profile
Approved
Email
send
Profile
Rejected
Email
send
Suspicious
Login
Email
send
Verification
Email
send
Welcome
Email
urembo-hub-api
Loading...
Get the status of the email service