Swift5 API client for mailslurp

MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It’s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.

Resources

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 6.5.2
  • Package version:
  • Build package: org.openapitools.codegen.languages.Swift5ClientCodegen

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AliasControllerAPIcreateAliasPOST /aliasesCreate an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
AliasControllerAPIdeleteAliasDELETE /aliases/{aliasId}Delete an email alias
AliasControllerAPIgetAliasGET /aliases/{aliasId}Get an email alias
AliasControllerAPIgetAliasEmailsGET /aliases/{aliasId}/emailsGet emails for an alias
AliasControllerAPIgetAliasThreadsGET /aliases/{aliasId}/threadsGet threads created for an alias
AliasControllerAPIgetAliasesGET /aliasesGet all email aliases you have created
AliasControllerAPIreplyToAliasEmailPUT /aliases/{aliasId}/emails/{emailId}Reply to an email
AliasControllerAPIsendAliasEmailPOST /aliases/{aliasId}/emailsSend an email from an alias inbox
AliasControllerAPIupdateAliasPUT /aliases/{aliasId}Update an email alias
AttachmentControllerAPIuploadAttachmentPOST /attachmentsUpload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
AttachmentControllerAPIuploadAttachmentBytesPOST /attachments/bytesUpload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
AttachmentControllerAPIuploadMultipartFormPOST /attachments/multipartUpload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
BulkActionsControllerAPIbulkCreateInboxesPOST /bulk/inboxesBulk create Inboxes (email addresses)
BulkActionsControllerAPIbulkDeleteInboxesDELETE /bulk/inboxesBulk Delete Inboxes
BulkActionsControllerAPIbulkSendEmailsPOST /bulk/sendBulk Send Emails
CommonActionsControllerAPIcreateNewEmailAddressPOST /createInboxCreate new random inbox
CommonActionsControllerAPIcreateNewEmailAddress1POST /newEmailAddressCreate new random inbox
CommonActionsControllerAPIemptyInboxDELETE /emptyInboxDelete all emails in an inbox
CommonActionsControllerAPIsendEmailSimplePOST /sendEmailSend an email
ContactControllerAPIcreateContactPOST /contactsCreate a contact
ContactControllerAPIdeleteContactDELETE /contacts/{contactId}Delete contact
ContactControllerAPIgetAllContactsGET /contacts/paginatedGet all contacts
ContactControllerAPIgetContactGET /contacts/{contactId}Get contact
ContactControllerAPIgetContactsGET /contactsGet all contacts
DomainControllerAPIaddDomainWildcardCatchAllPOST /domains/{id}/wildcardAdd catch all wild card inbox to domain
DomainControllerAPIcreateDomainPOST /domainsCreate Domain
DomainControllerAPIdeleteDomainDELETE /domains/{id}Delete a domain
DomainControllerAPIgetDomainGET /domains/{id}Get a domain
DomainControllerAPIgetDomainsGET /domainsGet domains
DomainControllerAPIupdateDomainPUT /domains/{id}Update a domain
EmailControllerAPIdeleteAllEmailsDELETE /emailsDelete all emails
EmailControllerAPIdeleteEmailDELETE /emails/{emailId}Delete an email
EmailControllerAPIdownloadAttachmentGET /emails/{emailId}/attachments/{attachmentId}Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
EmailControllerAPIdownloadAttachmentBase64GET /emails/{emailId}/attachments/{attachmentId}/base64Get email attachment as base64 encoded string (alternative to binary responses)
EmailControllerAPIforwardEmailPOST /emails/{emailId}/forwardForward email
EmailControllerAPIgetAttachmentMetaDataGET /emails/{emailId}/attachments/{attachmentId}/metadataGet email attachment metadata
EmailControllerAPIgetAttachmentsGET /emails/{emailId}/attachmentsGet all email attachment metadata
EmailControllerAPIgetEmailGET /emails/{emailId}Get email content
EmailControllerAPIgetEmailContentMatchPOST /emails/{emailId}/contentMatchGet email content regex pattern match results. Runs regex against email body and returns match groups.
EmailControllerAPIgetEmailHTMLGET /emails/{emailId}/htmlGet email content as HTML
EmailControllerAPIgetEmailHTMLQueryGET /emails/{emailId}/htmlQueryParse and return text from an email, stripping HTML and decoding encoded characters
EmailControllerAPIgetEmailTextLinesGET /emails/{emailId}/textLinesParse and return text from an email, stripping HTML and decoding encoded characters
EmailControllerAPIgetEmailsPaginatedGET /emailsGet all emails
EmailControllerAPIgetLatestEmailGET /emails/latestGet latest email
EmailControllerAPIgetLatestEmailInInboxGET /emails/latestInGet latest email
EmailControllerAPIgetOrganizationEmailsPaginatedGET /emails/organizationGet all organization emails
EmailControllerAPIgetRawEmailContentsGET /emails/{emailId}/rawGet raw email string
EmailControllerAPIgetRawEmailJsonGET /emails/{emailId}/raw/jsonGet raw email in JSON
EmailControllerAPIgetUnreadEmailCountGET /emails/unreadCountGet unread email count
EmailControllerAPIreplyToEmailPUT /emails/{emailId}Reply to an email
EmailControllerAPIvalidateEmailPOST /emails/{emailId}/validateValidate email
ExpiredControllerAPIgetExpirationDefaultsGET /expired/defaultsGet default expiration settings
ExpiredControllerAPIgetExpiredInboxByInboxIdGET /expired/inbox/{inboxId}Get expired inbox record for a previously existing inbox
ExpiredControllerAPIgetExpiredInboxRecordGET /expired/{expiredId}Get an expired inbox record
ExpiredControllerAPIgetExpiredInboxesGET /expiredList records of expired inboxes
FormControllerAPIsubmitFormPOST /formsSubmit a form to be parsed and sent as an email to an address determined by the form fields
GroupControllerAPIaddContactsToGroupPUT /groups/{groupId}/contactsAdd contacts to a group
GroupControllerAPIcreateGroupPOST /groupsCreate a group
GroupControllerAPIdeleteGroupDELETE /groups/{groupId}Delete group
GroupControllerAPIgetAllGroupsGET /groups/paginatedGet all Contact Groups in paginated format
GroupControllerAPIgetGroupGET /groups/{groupId}Get group
GroupControllerAPIgetGroupWithContactsGET /groups/{groupId}/contactsGet group and contacts belonging to it
GroupControllerAPIgetGroupWithContactsPaginatedGET /groups/{groupId}/contacts-paginatedGet group and paginated contacts belonging to it
GroupControllerAPIgetGroupsGET /groupsGet all groups
GroupControllerAPIremoveContactsFromGroupDELETE /groups/{groupId}/contactsRemove contacts from a group
InboxControllerAPIcreateInboxPOST /inboxesCreate an Inbox (email address)
InboxControllerAPIcreateInboxWithOptionsPOST /inboxes/withOptionsCreate an inbox with additional options
InboxControllerAPIdeleteAllInboxesDELETE /inboxesDelete all inboxes
InboxControllerAPIdeleteInboxDELETE /inboxes/{inboxId}Delete inbox
InboxControllerAPIgetAllInboxesGET /inboxes/paginatedList All Inboxes Paginated
InboxControllerAPIgetEmailsGET /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.
InboxControllerAPIgetInboxGET /inboxes/{inboxId}Get Inbox
InboxControllerAPIgetInboxEmailsPaginatedGET /inboxes/{inboxId}/emails/paginatedGet inbox emails paginated
InboxControllerAPIgetInboxSentEmailsGET /inboxes/{inboxId}/sentGet Inbox Sent Emails
InboxControllerAPIgetInboxTagsGET /inboxes/tagsGet inbox tags
InboxControllerAPIgetInboxesGET /inboxesList Inboxes / Email Addresses
InboxControllerAPIgetOrganizationInboxesGET /inboxes/organizationList Organization Inboxes Paginated
InboxControllerAPIsendEmailPOST /inboxes/{inboxId}Send Email
InboxControllerAPIsendEmailAndConfirmPOST /inboxes/{inboxId}/confirmSend email and return sent confirmation
InboxControllerAPIsetInboxFavouritedPUT /inboxes/{inboxId}/favouriteSet inbox favourited state
InboxControllerAPIupdateInboxPATCH /inboxes/{inboxId}Update Inbox
MailServerControllerAPIdescribeMailServerDomainPOST /mail-server/describe/domainGet DNS Mail Server records for a domain
MailServerControllerAPIgetDnsLookupPOST /mail-server/describe/dns-lookupLookup DNS records for a domain
MailServerControllerAPIgetIpAddressPOST /mail-server/describe/ip-addressGet IP address for a domain
MailServerControllerAPIverifyEmailAddressPOST /mail-server/verify/email-addressVerify the existence of an email address at a given mail server.
MissedEmailControllerAPIgetAllMissedEmailsGET /missed-emailsGet all MissedEmails in paginated format
MissedEmailControllerAPIgetMissedEmailGET /missed-emails/{MissedEmailId}Get MissedEmail
SentEmailsControllerAPIgetSentEmailGET /sent/{id}Get sent email receipt
SentEmailsControllerAPIgetSentEmailsGET /sentGet all sent emails in paginated form
SentEmailsControllerAPIgetSentOrganizationEmailsGET /sent/organizationGet all sent organization emails in paginated form
TemplateControllerAPIcreateTemplatePOST /templatesCreate a Template
TemplateControllerAPIdeleteTemplateDELETE /templates/{TemplateId}Delete Template
TemplateControllerAPIgetAllTemplatesGET /templates/paginatedGet all Templates in paginated format
TemplateControllerAPIgetTemplateGET /templates/{TemplateId}Get Template
TemplateControllerAPIgetTemplatesGET /templatesGet all Templates
WaitForControllerAPIwaitForPOST /waitForWait for conditions to be met
WaitForControllerAPIwaitForEmailCountGET /waitForEmailCountWait for and return count number of emails
WaitForControllerAPIwaitForLatestEmailGET /waitForLatestEmailFetch inbox's latest email or if empty wait for an email to arrive
WaitForControllerAPIwaitForMatchingEmailPOST /waitForMatchingEmailsWait or return list of emails that match simple matching patterns
WaitForControllerAPIwaitForMatchingFirstEmailPOST /waitForMatchingFirstEmailWait for or return the first email that matches proved MatchOptions array
WaitForControllerAPIwaitForNthEmailGET /waitForNthEmailWait for or fetch the email with a given index in the inbox specified
WebhookControllerAPIcreateWebhookPOST /inboxes/{inboxId}/webhooksAttach a WebHook URL to an inbox
WebhookControllerAPIdeleteWebhookDELETE /inboxes/{inboxId}/webhooks/{webhookId}Delete and disable a Webhook for an Inbox
WebhookControllerAPIgetAllWebhooksGET /webhooks/paginatedList Webhooks Paginated
WebhookControllerAPIgetWebhookGET /webhooks/{webhookId}Get a webhook for an Inbox
WebhookControllerAPIgetWebhooksGET /inboxes/{inboxId}/webhooksGet all Webhooks for an Inbox
WebhookControllerAPIsendTestDataPOST /webhooks/{webhookId}/testSend webhook test data

Documentation For Models

Documentation For Authorization

API_KEY

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

More