testEmailWithHttpInfo method

Future<Response> testEmailWithHttpInfo(
  1. MmConfig mmConfig
)

Send a test email

Send a test email to make sure you have your email settings configured correctly. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested. ##### Permissions Must have manage_system permission.

Note: This method returns the HTTP Response.

Parameters:

  • MmConfig mmConfig (required): Mattermost configuration

Implementation

Future<Response> testEmailWithHttpInfo(
  MmConfig mmConfig,
) async {
  // ignore: prefer_const_declarations
  final path = r'/email/test';

  // ignore: prefer_final_locals
  Object? postBody = mmConfig;

  final queryParams = <MmQueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}