Class Email

Hierarchy

NotificationService
- Email

Implements

Component

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Email(options: EmailServiceOptions): Email

Overrides NotificationService.constructor
- Defined in email/EmailService.ts:48
Instantiates a new email service instance.

Parameters
- options: EmailServiceOptions
  
  The email service options
Returns Email

Properties

children

children: Component[]

logger

logger: LoggerInstance

options

options: NotificationServiceOptions

The notification service options

Protected Optional templateEngine

templateEngine: Template

Protected Optional transporter

transporter: nodemailer.Transporter

type

type: GROUP

Methods

component

component(component: Component): number

Inherited from ComponentGroup.component
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:50
Register a new component.

Parameters
- component: Component
Returns number

components

components(): Component[]

Inherited from ComponentGroup.components
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:46
Gets currently registered components.

Returns Component[]

describe

describe(): ComponentGroupDescription

Inherited from ComponentGroup.describe
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:26
Describes current component group.

Returns ComponentGroupDescription

isReady

isReady(): Promise<boolean>

- Defined in email/EmailService.ts:99
Verifies if the SMTP connection is OK.

Returns Promise<boolean>

onInit

onInit(server: BaseServer): Promise<void>

Inherited from ComponentGroup.onInit
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:34
Handles pre initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onMount

onMount(server: BaseServer): void

Inherited from ComponentGroup.onMount
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:30
Handles post mount routines.

Parameters
- server: BaseServer
Returns void

onReady

onReady(server: BaseServer): Promise<void>

Inherited from ComponentGroup.onReady
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:38
Handles post initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onUnmount

onUnmount(server: BaseServer): void

Inherited from ComponentGroup.onUnmount
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:42
Handles post unmount routines.

Parameters
- server: BaseServer
Returns void

send

send(message: EmailMessageSchema): Promise<any>

Overrides NotificationService.send
- Defined in email/EmailService.ts:118
Sends an email message.

Parameters
- message: EmailMessageSchema
  
  The message options
Returns Promise<any>

Generated using TypeDoc