SAF Documentation

@saflib/email-spec

Interface: paths ​

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Properties ​

/email/kratos-courier ​

/email/kratos-courier: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Receive email dispatch from Ory Kratos HTTP courier

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.recipient ​

recipient: string

post.requestBody.content.application/json.template_data? ​

optional template_data: object

Index Signature ​

[key: string]: unknown

post.requestBody.content.application/json.template_type ​

template_type: string

post.responses ​

responses: object

post.responses.204 ​

204: object

Description ​

Email accepted for delivery

post.responses.204.content? ​

optional content: undefined

post.responses.204.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.500 ​

500: object

Description ​

Failed to send email

post.responses.500.content ​

content: object

post.responses.500.content.application/json ​

application/json: object

post.responses.500.content.application/json.code? ​

optional code: string

Description ​

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

post.responses.500.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.500.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/email/sent ​

/email/sent: object

delete? ​

optional delete: undefined

get ​

get: object

List all sent emails

get.parameters ​

parameters: object

optional cookie: undefined

get.parameters.header? ​

optional header: undefined

get.parameters.path? ​

optional path: undefined

get.parameters.query? ​

optional query: object

get.parameters.query.user_email? ​

optional user_email: string

Description ​

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

get.requestBody? ​

optional requestBody: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Description ​

A list of sent emails.

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object[]

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.403 ​

403: object

Description ​

Forbidden - server is not mocking email sends

get.responses.403.content ​

content: object

get.responses.403.content.application/json ​

application/json: object

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

optional code: string

Description ​

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

get.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.
get.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post? ​

optional post: undefined

put? ​

optional put: undefined

trace? ​

optional trace: undefined