Skip to content

@saflib/email-spec


Interface: operations

Properties

listSentEmails

listSentEmails: object

parameters

parameters: object

optional cookie: undefined

parameters.header?

optional header: undefined

parameters.path?

optional path: undefined

parameters.query?

optional query: object

parameters.query.user_email?

optional user_email: string

Description

The email address of the user to get sent emails to or from

requestBody?

optional requestBody: undefined

responses

responses: object

responses.200

200: object

Description

A list of sent emails.

responses.200.content

content: object

responses.200.content.application/json

application/json: object[]

responses.200.headers

headers: object

Index Signature

[name: string]: unknown

responses.403

403: object

Description

Forbidden - server is not mocking email sends

responses.403.content

content: object

responses.403.content.application/json

application/json: object

responses.403.content.application/json.code?

optional code: string

Description

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.403.content.application/json.message?

optional message: string

Description

A human-readable description of the error.

Example
ts
The requested resource could not be found.
responses.403.headers

headers: object

Index Signature

[name: string]: unknown