diff --git a/specs/sandbox.openapi.yml b/specs/sandbox.openapi.yml index 7bd80a3..373703f 100644 --- a/specs/sandbox.openapi.yml +++ b/specs/sandbox.openapi.yml @@ -4410,12 +4410,12 @@ paths: '/api/sandboxes/{sandbox_id}/messages/{message_id}/body.htmlsource': get: summary: Get message source - description: Get HTML source of email. + description: Get the HTML body of an email as it was sent. Not applicable for plain text emails. tags: - Messages responses: '200': - description: Returns HTML source of a message. + description: Returns the HTML body as it was sent. content: text/html: schema: @@ -4426,6 +4426,8 @@ paths: + + @@ -4441,11 +4443,13 @@ paths:

Now send your email using our fake SMTP server and integration of your choice!

+

Confirm your email

Good luck! Hope it works.

- @@ -4589,22 +4593,55 @@ paths: '/api/sandboxes/{sandbox_id}/messages/{message_id}/body.html': get: summary: Get HTML message - description: Get formatted HTML email body. Not applicable for plain text emails. + description: | + Get the HTML body of an email, sanitized for preview. Not applicable for plain text emails. + + The response is not the email as it was sent. Mailtrap changes it as follows: + + - The response is always a full HTML document with `html`, `head` and `body` elements. + - The first element in `head` is a `` tag. + - Entities such as `©` come back as the character (`©`). `&`, `<`, `>`, non-breaking spaces and quotes in attribute values stay escaped, so a raw `&` in a link URL comes back as `&`. + - Scripts and stylesheet links are removed. Stylesheet links to Google Fonts stay. + - Each `@import` rule in a ` - - + + + '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': @@ -4650,6 +4689,14 @@ paths: schema: type: string example: Conflict + '429': + description: Mailtrap is sanitizing too many large HTML bodies at the same time. Retry after the number of seconds in `Retry-After`. + headers: + Retry-After: + description: The number of seconds to wait before you retry. + schema: + type: integer + example: 2 x-codeSamples: - lang: shell label: 'cURL'