MailSlurpMissedEmailControllerApi

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

MethodHTTP requestDescription
GetAllMissedEmailsGet /missed-emailsGet all MissedEmails in paginated format
GetAllUnknownMissedEmailsGet /missed-emails/unknownGet all unknown missed emails in paginated format
GetMissedEmailGet /missed-emails/{missedEmailId}Get MissedEmail
WaitForNthMissedEmailGet /missed-emails/waitForNthMissedEmailWait for Nth missed email

GetAllMissedEmails

PageMissedEmailProjection GetAllMissedEmails(ctx, optional)

Get all MissedEmails in paginated format

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAllMissedEmailsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllMissedEmailsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
inboxIdoptional.Interface of stringOptional inbox ID filter
pageoptional.Int32Optional page in list pagination[default to 0]
searchFilteroptional.StringOptional search filter
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in list pagination[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[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

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAllUnknownMissedEmailsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllUnknownMissedEmailsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
inboxIdoptional.Interface of stringOptional inbox ID filter
pageoptional.Int32Optional page in list pagination[default to 0]
searchFilteroptional.StringOptional search filter
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in list pagination[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageUnknownMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetMissedEmail

MissedEmail GetMissedEmail(ctx, missedEmailId)

Get MissedEmail

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
missedEmailIdstringmissedEmailId

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[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

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*WaitForNthMissedEmailOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForNthMissedEmailOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
inboxIdoptional.Interface of stringOptional inbox ID filter
****optional.Int32Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
sinceoptional.TimeFilter by created at after the given timestamp
timeoutoptional.Int64Optional timeout milliseconds

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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