Lettermint.Projects.ReportForwarding (Lettermint v2.0.0)

DMARC and complaint report forwarding of a project. Needs :team_token.

Every function takes the options timeout: (milliseconds) last.

Summary

Types

result(value)

Functions

delete(client, project_id, options \\ [])

Disables report forwarding. Returns :ok (HTTP 204).

resend_code(client, project_id, options \\ [])

Sends the verification code again.

retrieve(client, project_id, options \\ [])

The report forwarding settings of a project.

update(client, project_id, body, options \\ [])

Sets the report forwarding address.

verify(client, project_id, body, options \\ [])

Verifies the forwarding address with the emailed code.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}

Functions

delete(client, project_id, options \\ [])

@spec delete(Lettermint.Client.t(), String.t(), keyword()) ::
  :ok | {:error, Lettermint.Error.t()}

Disables report forwarding. Returns :ok (HTTP 204).

resend_code(client, project_id, options \\ [])

@spec resend_code(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.ResendReportForwardingCodeResponse.t())

Sends the verification code again.

retrieve(client, project_id, options \\ [])

@spec retrieve(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.GetReportForwardingResponse.t())

The report forwarding settings of a project.

update(client, project_id, body, options \\ [])

@spec update(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ReportForwardingRequest.t() | map(),
  keyword()
) :: result(Lettermint.Types.UpdateReportForwardingResponse.t())

Sets the report forwarding address.

verify(client, project_id, body, options \\ [])

@spec verify(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.VerifyReportForwardingRequest.t() | map(),
  keyword()
) :: result(Lettermint.Types.VerifyReportForwardingResponse.t())

Verifies the forwarding address with the emailed code.