Conga Digital Commerce 202405.2.0 on Conga Revenue Lifecycle Platform
  1. Injectables
  2. EmailService

File

projects/congarevenuecloud/ecommerce/src/lib/modules/crm/services/email.service.ts

Description

The email service provides methods for sending email notifications to recipients which current user has access to.

Extends

AObjectService

Index

Properties
Methods

Methods

getEmailTemplateByName
getEmailTemplateByName(templateName: string)

This method is responsible for fetching the email template for a given template name passed.

Parameters :
Name Type Optional Description
templateName string No

string representing name of the template to be retrieved.
Returns : Observable<EmailTemplate>

an observable instance of the email template record matching the template name.
Public guestUserNewOrderNotification
This method is deprecated on Conga platform. Please use sendEmailNotificationWithTemplate method instead, to send email notifications for order confirmation.
guestUserNewOrderNotification(orderId: string, orderURL: string)

Please use sendEmailNotificationWithTemplate method instead, to send email notifications for order confirmation.

Parameters :
Name Type Optional
orderId string No
orderURL string No
Returns : Observable<any>
Public sendEmail
This method is deprecated on Conga platform. Please use sendEmailNotificationWithTemplate method instead, to send email notifications. Sends email with the list of email content.
sendEmail(emailContentList: MailContent[])

Please use sendEmailNotificationWithTemplate method instead, to send email notifications. Sends email with the list of email content.

Parameters :
Name Type Optional Description
emailContentList MailContent[] No

is an array of mail content having toAddress,ccAddressesa,replyTo and more.
Returns : Observable<any>

an observable
sendEmailNotificationWithTemplate
sendEmailNotificationWithTemplate(templateId: string, record: AObject, recipientId: string, toAddresses?: Array<EmailInfo>, ccAddresses?: Array<EmailInfo>, bccAddresses?: Array<EmailInfo>, emailPriority: string)

The method can be used to trigger email notifications based on the email template provided. Sends notification to a single user/multiple users based on the input.

Parameters :
Name Type Optional Default value Description
templateId string No

template identifier to be used for sending email.
record AObject No

instance of AObject record.
recipientId string No

string identifier representing the primary contact on the record.
toAddresses Array<EmailInfo> Yes

List of recipient email addresses.
ccAddresses Array<EmailInfo> Yes

Optional list of EmailInfo instance containing details to appear in carbon copy(cc).
bccAddresses Array<EmailInfo> Yes

Optional list of EmailInfo instance containing details to appear in blank carbon copy(bcc).
emailPriority string No 'Normal'

string value specifying the email piority. Defaulted to normal.
Returns : Observable<boolean>

a boolean observable representing the status code.
Public sendEmailTemplate
This method is deprecated on Conga platform. Please use sendEmailNotificationWithTemplate method instead, to send email notifications with template.
sendEmailTemplate(templateName: string, to: User, what: AObject)

Please use sendEmailNotificationWithTemplate method instead, to send email notifications with template.

Parameters :
Name Type Optional
templateName string No
to User No
what AObject No
Returns : Observable<any>
Public sendEmailToAddress
This method is deprecated on Conga platform. Please use sendEmailNotificationWithTemplate method instead, to send email notifications with template.
sendEmailToAddress(templateName: string, from: User, to: string, what: AObject)

Please use sendEmailNotificationWithTemplate method instead, to send email notifications with template.

Parameters :
Name Type Optional
templateName string No
from User No
to string No
what AObject No
Returns : Observable<any>
statusChangeNotification
This method is deprecated on Conga platform. Please use sendEmailNotificationWithTemplate method instead, to send status change email notifications.
statusChangeNotification(templateId: string, recordId: string, recordType: AObject, recipientId: string, toAddresses?: string[], ccAddresses?: string[], attachmentIds?: string[])

Please use sendEmailNotificationWithTemplate method instead, to send status change email notifications.

Parameters :
Name Type Optional
templateId string No
recordId string No
recordType AObject No
recipientId string No
toAddresses string[] Yes
ccAddresses string[] Yes
attachmentIds string[] Yes
Returns : Observable<boolean>

Properties

Protected contactService
Type : ContactService
Default value : this.injector.get(ContactService)
Protected toastrService
Type : ToastrService
Default value : this.injector.get(ToastrService)
Protected userService
Type : UserService
Default value : this.injector.get(UserService)

results matching ""

    No results matching ""