talawa-api / Exports / setup/verifySmtpConnection
Module: setup/verifySmtpConnection
Table of contents
Functions
Functions
verifySmtpConnection
▸ verifySmtpConnection(config): Promise<VerifySmtpConnectionReturnType>
The function verifySmtpConnection verifies the SMTP connection using the provided configuration
and returns a success status and error message if applicable.
Parameters
| Name | Type | Description |
|---|---|---|
config | Record<string, string> | The config parameter is an object that contains the configuration settings for the SMTP connection. It should have the following properties: |
Returns
Promise<VerifySmtpConnectionReturnType>
The function verifySmtpConnection returns a Promise that resolves to an object of type
VerifySmtpConnectionReturnType. The VerifySmtpConnectionReturnType object has two properties:
success and error. If the SMTP connection is verified successfully, the success property will
be true and the error property will be null. If the SMTP connection verification fails