FlowMailSender Methods
An object defining methods for the FlowMailSender class.
Send()
Sends the email with the configured settings.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddRecipientTO(recipient)
Adds a recipient to the primary recipients list using recipient options.
Parameters:
recipient (required): IMailRecipientsOptions
The recipient options object containing the email address.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddRecipientCC(recipient)
Adds a recipient to the CC list using recipient options.
Parameters:
recipient (required): IMailRecipientsOptions
The recipient options object containing the email address.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddRecipientBCC(recipient)
Adds a recipient to the BCC list using recipient options.
Parameters:
recipient (required): IMailRecipientsOptions
The recipient options object containing the email address.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
ClearBCC()
Clears all BCC recipients from the email.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
ClearTO()
Clears all primary recipients from the email.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddCC(recipient)
Adds a recipient to the CC (carbon copy) list of the email.
Parameters:
recipient (required): string
The email address of the recipient to be added to CC.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddTO(recipient)
Adds a primary recipient to the email.
Parameters:
recipient (required): string
The email address of the recipient to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveTO(recipient)
Removes a primary recipient from the email.
Parameters:
recipient (required): string
The email address of the recipient to be removed.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddAttachment(value, type)
Adds an attachment to the email.
Parameters:
value (required): string
The path or content of the attachment.
type (required): MailAttachmentType
The type of the attachment (e.g., file, inline).
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveBCC(recipient)
Removes a recipient from the BCC list of the email.
Parameters:
recipient (required): string
The email address of the recipient to be removed from BCC.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveCC(recipient)
Removes a recipient from the CC list of the email.
Parameters:
recipient (required): string
The email address of the recipient to be removed from CC.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddBCC(recipient)
Adds a recipient to the BCC (blind carbon copy) list of the email.
Parameters:
recipient (required): string
The email address of the recipient to be added to BCC.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
Initialize()
Initializes the FlowMailSender with default configurations.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
ClearCC()
Clears all CC recipients from the email.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.