mailslurp
v15.17.22

MailSlurpAPI.Api.ToolsController (mailslurp v15.17.22)

API calls for all endpoints tagged ToolsController.

Summary

Functions

generate_bimi_record(connection, generate_bimi_record_options, opts \\ [])

Create a BIMI record policy

generate_dmarc_record(connection, generate_dmarc_record_options, opts \\ [])

Create a DMARC record policy

generate_mta_sts_record(connection, generate_mta_sts_record_options, opts \\ [])

Create a TLS reporting record policy

generate_tls_reporting_record(connection, generate_tls_reporting_record_options, opts \\ [])

Create a TLS reporting record policy

lookup_bimi_domain(connection, lookup_bimi_domain_options, opts \\ [])

Lookup a BIMI record policy

lookup_dmarc_domain(connection, lookup_dmarc_domain_options, opts \\ [])

Lookup a DMARC record policy

lookup_mta_sts_domain(connection, lookup_mta_sts_domain_options, opts \\ [])

Lookup a MTA-STS domain policy

lookup_tls_reporting_domain(connection, lookup_tls_reporting_domain_options, opts \\ [])

Lookup a TLS reporting domain policy

Functions

Link to this function

generate_bimi_record(connection, generate_bimi_record_options, opts \\ [])

@spec generate_bimi_record(
  Tesla.Env.client(),
  MailSlurpAPI.Model.GenerateBimiRecordOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.GenerateBimiRecordResults.t()}
  | {:error, Tesla.Env.t()}

Create a BIMI record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • generate_bimi_record_options (GenerateBimiRecordOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

generate_dmarc_record(connection, generate_dmarc_record_options, opts \\ [])

@spec generate_dmarc_record(
  Tesla.Env.client(),
  MailSlurpAPI.Model.GenerateDmarcRecordOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.GenerateDmarcRecordResults.t()}
  | {:error, Tesla.Env.t()}

Create a DMARC record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • generate_dmarc_record_options (GenerateDmarcRecordOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

generate_mta_sts_record(connection, generate_mta_sts_record_options, opts \\ [])

@spec generate_mta_sts_record(
  Tesla.Env.client(),
  MailSlurpAPI.Model.GenerateMtaStsRecordOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.GenerateMtaStsRecordResults.t()}
  | {:error, Tesla.Env.t()}

Create a TLS reporting record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • generate_mta_sts_record_options (GenerateMtaStsRecordOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

generate_tls_reporting_record(connection, generate_tls_reporting_record_options, opts \\ [])

@spec generate_tls_reporting_record(
  Tesla.Env.client(),
  MailSlurpAPI.Model.GenerateTlsReportingRecordOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.GenerateTlsReportingRecordResults.t()}
  | {:error, Tesla.Env.t()}

Create a TLS reporting record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • generate_tls_reporting_record_options (GenerateTlsReportingRecordOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

lookup_bimi_domain(connection, lookup_bimi_domain_options, opts \\ [])

@spec lookup_bimi_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.LookupBimiDomainOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.LookupBimiDomainResults.t()}
  | {:error, Tesla.Env.t()}

Lookup a BIMI record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • lookup_bimi_domain_options (LookupBimiDomainOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

lookup_dmarc_domain(connection, lookup_dmarc_domain_options, opts \\ [])

@spec lookup_dmarc_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.LookupDmarcDomainOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.LookupDmarcDomainResults.t()}
  | {:error, Tesla.Env.t()}

Lookup a DMARC record policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • lookup_dmarc_domain_options (LookupDmarcDomainOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

lookup_mta_sts_domain(connection, lookup_mta_sts_domain_options, opts \\ [])

@spec lookup_mta_sts_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.LookupMtaStsDomainOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.LookupMtaStsDomainResults.t()}
  | {:error, Tesla.Env.t()}

Lookup a MTA-STS domain policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • lookup_mta_sts_domain_options (LookupMtaStsDomainOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

lookup_tls_reporting_domain(connection, lookup_tls_reporting_domain_options, opts \\ [])

@spec lookup_tls_reporting_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.LookupTlsReportingDomainOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.LookupTlsReportingDomainResults.t()}
  | {:error, Tesla.Env.t()}

Lookup a TLS reporting domain policy

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • lookup_tls_reporting_domain_options (LookupTlsReportingDomainOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure