MailSlurpInboxControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptionCreateInboxPost /inboxesCreate an inbox email address. An inbox has a real email address and can send and receive emails.CreateInboxWithDefaultsPost /inboxes/withDefaultsCreate an inbox with default options. Uses MailSlurp domain pool address and is private.CreateInboxWithOptionsPost /inboxes/withOptionsCreate an inbox with options. Extended options for inbox creation.DeleteAllInboxesDelete /inboxesDelete all inboxesDeleteInboxDelete /inboxes/{inboxId}Delete inboxGetAllInboxesGet /inboxes/paginatedList All Inboxes PaginatedGetEmailsGet /inboxes/{inboxId}/emailsGet emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.GetInboxGet /inboxes/{inboxId}Get Inbox. Returns properties of an inbox.GetInboxEmailsPaginatedGet /inboxes/{inboxId}/emails/paginatedGet inbox emails paginatedGetInboxSentEmailsGet /inboxes/{inboxId}/sentGet Inbox Sent EmailsGetInboxTagsGet /inboxes/tagsGet inbox tagsGetInboxesGet /inboxesList Inboxes and email eddressesGetOrganizationInboxesGet /inboxes/organizationList Organization Inboxes PaginatedSendEmailPost /inboxes/{inboxId}Send EmailSendEmailAndConfirmPost /inboxes/{inboxId}/confirmSend email and return sent confirmationSetInboxFavouritedPut /inboxes/{inboxId}/favouriteSet inbox favourited stateUpdateInboxPatch /inboxes/{inboxId}Update Inbox. Change name and description. Email address is not editable.CreateInboxInbox CreateInbox(ctx, optional)Create an inbox email address. An inbox has a real email address and can send and receive emails.Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*CreateInboxOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a CreateInboxOpts structNameTypeDescriptionNotesallowTeamAccessoptional.BoolGrant team access to this inbox and the emails that belong to it for team members of your organization.descriptionoptional.StringOptional description of the inbox for labelling purposes. Is shown in the dashboard and can be used withemailAddressoptional.StringA custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com. If you use the useDomainPool option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info or 123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.expiresAtoptional.TimeOptional inbox expiration date. If null then this inbox is permanent and the emails in it won’t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd’T’HH:mm:ss.SSSXXX.expiresInoptional.Int64Number of milliseconds that inbox should exist forfavouriteoptional.BoolIs the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filteringnameoptional.StringOptional name of the inbox. Displayed in the dashboard for easier searchtags**optional.Interface of []string**Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.useDomainPooloptional.BoolUse the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...} . This means a TLD is randomly selecting from a list of .biz, .info, .xyz etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com or custom email address provided by the emailAddress field.Return typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]CreateInboxWithDefaultsInbox CreateInboxWithDefaults(ctx, )Create an inbox with default options. Uses MailSlurp domain pool address and is private.Required ParametersThis endpoint does not need any parameter.Return typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]CreateInboxWithOptionsInbox CreateInboxWithOptions(ctx, createInboxDto)Create an inbox with options. Extended options for inbox creation.Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.createInboxDtoCreateInboxDtocreateInboxDtoReturn typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]DeleteAllInboxesDeleteAllInboxes(ctx, )Delete all inboxesPermanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.Required ParametersThis endpoint does not need any parameter.Return type(empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]DeleteInboxDeleteInbox(ctx, inboxId)Delete inboxPermanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdReturn type(empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]GetAllInboxesPageInboxProjection GetAllInboxes(ctx, optional)List All Inboxes PaginatedList inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set teamAccess to true.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetAllInboxesOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetAllInboxesOpts structNameTypeDescriptionNotesfavouriteoptional.BoolOptionally filter results for favourites only[default to false]pageoptional.Int32Optional page in inbox list pagination[default to 0]searchoptional.StringOptionally filter by search words partial matching ID, tags, name, and email addresssizeoptional.Int32Optional page size in inbox list pagination[default to 20]sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]tagoptional.StringOptionally filter by tags. Will return inboxes that include given tagsteamAccessoptional.BoolOptionally filter by team access. Defaults to false so organization inboxes are not included[default to false]Return typePageInboxProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetEmails[]EmailPreview GetEmails(ctx, inboxId, optional)Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.List emails that an inbox has received. Only emails that are sent to the inbox’s email address will appear in the inbox. It may take several seconds for any email you send to an inbox’s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reachedRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringId of inbox that emails belongs tooptional*GetEmailsOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetEmailsOpts structNameTypeDescriptionNoteslimit | optional.Int32| Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller | minCount | optional.Int64| Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. | retryTimeout | optional.Int64| Maximum milliseconds to spend retrying inbox database until minCount emails are returned | since | optional.Time| Exclude emails received before this ISO 8601 date time | size | optional.Int32| Alias for limit. Assessed first before assessing any passed limit. | sort | optional.String| Sort the results by received date and direction ASC or DESC |Return type**[]EmailPreview**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxInbox GetInbox(ctx, inboxId)Get Inbox. Returns properties of an inbox.Returns an inbox’s properties, including its email address and ID.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdReturn typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxEmailsPaginatedPageEmailPreview GetInboxEmailsPaginated(ctx, inboxId, optional)Get inbox emails paginatedGet a paginated list of emails in an inbox. Does not hold connections open.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringId of inbox that emails belongs tooptional*GetInboxEmailsPaginatedOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetInboxEmailsPaginatedOpts structNameTypeDescriptionNotespage | optional.Int32| Optional page in inbox emails list pagination | [default to 0] size | optional.Int32| Optional page size in inbox emails list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]Return typePageEmailPreviewAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxSentEmailsPageSentEmailProjection GetInboxSentEmails(ctx, inboxId, optional)Get Inbox Sent EmailsReturns an inbox’s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdoptional*GetInboxSentEmailsOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetInboxSentEmailsOpts structNameTypeDescriptionNotespage | optional.Int32| Optional page in inbox sent email list pagination | [default to 0] size | optional.Int32| Optional page size in inbox sent email list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]Return typePageSentEmailProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxTags[]string GetInboxTags(ctx, )Get inbox tagsGet all inbox tagsRequired ParametersThis endpoint does not need any parameter.Return type[]stringAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxes[]Inbox GetInboxes(ctx, optional)List Inboxes and email eddressesList the inboxes you have created. Note use of the more advanced getAllEmails is recommended. You can provide a limit and sort parameter.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetInboxesOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetInboxesOpts structNameTypeDescriptionNotessizeoptional.Int32Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated getAllEmails for larger queries.[default to 100]sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]Return type**[]Inbox**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetOrganizationInboxesPageOrganizationInboxProjection GetOrganizationInboxes(ctx, optional)List Organization Inboxes PaginatedList organization inboxes in paginated form. These are inboxes created with allowTeamAccess flag enabled. Organization inboxes are readOnly for non-admin users. The results are available on the content property of the returned object. This method allows for page (zero based), page size (how many results to return), and a sort direction (based on createdAt time).Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetOrganizationInboxesOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetOrganizationInboxesOpts structNameTypeDescriptionNotespageoptional.Int32Optional page in inbox list pagination[default to 0]sizeoptional.Int32Optional page size in inbox list pagination[default to 20]sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]Return typePageOrganizationInboxProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]SendEmailSendEmail(ctx, inboxId, optional)Send EmailSend an email from an inbox’s email address. The request body should contain the SendEmailOptions that include recipients, attachments, body etc. See SendEmailOptions for all available properties. Note the inboxId refers to the inbox’s id not the inbox’s email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method sendEmailAndConfirm.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringID of the inbox you want to send the email fromoptional*SendEmailOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a SendEmailOpts structNameTypeDescriptionNotessendEmailOptions | optional.Interface of SendEmailOptions| Options for the email |Return type(empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]SendEmailAndConfirmSentEmailDto SendEmailAndConfirm(ctx, inboxId, optional)Send email and return sent confirmationSister method for standard sendEmail method with the benefit of returning a SentEmail entity confirming the successful sending of the email with a link to the sent object created for it.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringID of the inbox you want to send the email fromoptional*SendEmailAndConfirmOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a SendEmailAndConfirmOpts structNameTypeDescriptionNotessendEmailOptions | optional.Interface of SendEmailOptions| Options for the email |Return typeSentEmailDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]SetInboxFavouritedInbox SetInboxFavourited(ctx, inboxId, setInboxFavouritedOptions)Set inbox favourited stateSet and return new favourite state for an inboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdsetInboxFavouritedOptionsSetInboxFavouritedOptionssetInboxFavouritedOptionsReturn typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]UpdateInboxInbox UpdateInbox(ctx, inboxId, updateInboxOptions)Update Inbox. Change name and description. Email address is not editable.Update editable fields on an inboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdupdateInboxOptionsUpdateInboxOptionsupdateInboxOptionsReturn typeInboxAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]
MailSlurp