Skip to content

MailSlurp\MissedEmailControllerApi

All URIs are relative to https://golang.api.mailslurp.com

Method HTTP request Description
GetAllMissedEmails Get /missed-emails Get all MissedEmails in paginated format
GetAllUnknownMissedEmails Get /missed-emails/unknown Get all unknown missed emails in paginated format
GetMissedEmail Get /missed-emails/{missedEmailId} Get MissedEmail
RestoreMissedEmails Post /missed-emails/restore Restore missed emails
WaitForNthMissedEmail Get /missed-emails/waitForNthMissedEmail Wait for Nth missed email

GetAllMissedEmails

PageMissedEmailProjection GetAllMissedEmails(ctx, optional)

Get all MissedEmails in paginated format

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllMissedEmailsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllMissedEmailsOpts struct

Name Type Description Notes
page optional.Int32 Optional page in list pagination [default to 0]
size optional.Int32 Optional page size in list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp
inboxId optional.Interface of string Optional inbox ID filter

Return type

PageMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAllUnknownMissedEmails

PageUnknownMissedEmailProjection GetAllUnknownMissedEmails(ctx, optional)

Get all unknown missed emails in paginated format

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllUnknownMissedEmailsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllUnknownMissedEmailsOpts struct

Name Type Description Notes
page optional.Int32 Optional page in list pagination [default to 0]
size optional.Int32 Optional page size in list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp
inboxId optional.Interface of string Optional inbox ID filter

Return type

PageUnknownMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetMissedEmail

MissedEmail GetMissedEmail(ctx, missedEmailId)

Get MissedEmail

List emails that were missed due to plan limits.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
missedEmailId string

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

RestoreMissedEmails

RestoreMissedEmails(ctx, )

Restore missed emails

If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

WaitForNthMissedEmail

MissedEmail WaitForNthMissedEmail(ctx, , optional)

Wait for Nth missed email

Wait for 0 based missed email

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
**** int32 Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
optional *WaitForNthMissedEmailOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForNthMissedEmailOpts struct

Name Type Description Notes

inboxId | optional.Interface of string| Optional inbox ID filter | timeout | optional.Int64| Optional timeout milliseconds | since | optional.Time| Filter by created at after the given timestamp | before | optional.Time| Filter by created at before the given timestamp |

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]