| Package | Description |
|---|---|
| com.mailslurp.apis | |
| com.mailslurp.clients |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<GroupContactsDto> |
GroupControllerApi.addContactsToGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Add contacts to a group
|
ApiResponse<DomainDto> |
DomainControllerApi.addDomainWildcardCatchAllWithHttpInfo(UUID id)
Add catch all wild card inbox to domain
Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
|
ApiResponse<List<Inbox>> |
BulkActionsControllerApi.bulkCreateInboxesWithHttpInfo(Integer count)
Bulk create Inboxes (email addresses)
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkDeleteInboxesWithHttpInfo(List<UUID> ids)
Bulk Delete Inboxes
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkSendEmailsWithHttpInfo(BulkSendEmailOptions bulkSendEmailOptions)
Bulk Send Emails
|
ApiResponse<AliasDto> |
AliasControllerApi.createAliasWithHttpInfo(CreateAliasOptions createAliasOptions)
Create an email alias.
|
ApiResponse<ContactDto> |
ContactControllerApi.createContactWithHttpInfo(CreateContactOptions createContactOptions)
Create a contact
|
ApiResponse<DomainDto> |
DomainControllerApi.createDomainWithHttpInfo(CreateDomainOptions domainOptions)
Create Domain
Link a domain that you own with MailSlurp so you can create email addresses using it.
|
ApiResponse<GroupDto> |
GroupControllerApi.createGroupWithHttpInfo(CreateGroupOptions createGroupOptions)
Create a group
|
ApiResponse<Inbox> |
InboxControllerApi.createInboxWithHttpInfo(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool)
Create an Inbox (email address)
Create a new inbox and with a randomized email address to send and receive from.
|
ApiResponse<Inbox> |
InboxControllerApi.createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto)
Create an inbox with additional options
Additional endpoint that allows inbox creation with request body options.
|
ApiResponse<Inbox> |
CommonActionsControllerApi.createNewEmailAddress1WithHttpInfo(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
ApiResponse<Inbox> |
CommonActionsControllerApi.createNewEmailAddressWithHttpInfo(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
ApiResponse<TemplateDto> |
TemplateControllerApi.createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions)
Create a Template
|
ApiResponse<WebhookDto> |
WebhookControllerApi.createWebhookWithHttpInfo(UUID inboxId,
CreateWebhookOptions webhookOptions)
Attach a WebHook URL to an inbox
Get notified whenever an inbox receives an email via a WebHook URL.
|
ApiResponse<Void> |
AliasControllerApi.deleteAliasWithHttpInfo(UUID aliasId)
Delete an email alias
|
ApiResponse<Void> |
EmailControllerApi.deleteAllEmailsWithHttpInfo()
Delete all emails
Deletes all emails in your account.
|
ApiResponse<Void> |
InboxControllerApi.deleteAllInboxesWithHttpInfo()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
ApiResponse<Void> |
ContactControllerApi.deleteContactWithHttpInfo(UUID contactId)
Delete contact
|
ApiResponse<List<String>> |
DomainControllerApi.deleteDomainWithHttpInfo(UUID id)
Delete a domain
Delete a domain.
|
ApiResponse<Void> |
EmailControllerApi.deleteEmailWithHttpInfo(UUID emailId)
Delete an email
Deletes an email and removes it from the inbox.
|
ApiResponse<Void> |
GroupControllerApi.deleteGroupWithHttpInfo(UUID groupId)
Delete group
|
ApiResponse<Void> |
InboxControllerApi.deleteInboxWithHttpInfo(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
ApiResponse<Void> |
TemplateControllerApi.deleteTemplateWithHttpInfo(UUID templateId)
Delete Template
|
ApiResponse<Void> |
WebhookControllerApi.deleteWebhookWithHttpInfo(UUID inboxId,
UUID webhookId)
Delete and disable a Webhook for an Inbox
|
ApiResponse<DescribeMailServerDomainResult> |
MailServerControllerApi.describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeOptions)
Get DNS Mail Server records for a domain
|
ApiResponse<DownloadAttachmentDto> |
EmailControllerApi.downloadAttachmentBase64WithHttpInfo(String attachmentId,
UUID emailId)
Get email attachment as base64 encoded string (alternative to binary responses)
Returns the specified attachment for a given email as a base 64 encoded string.
|
ApiResponse<byte[]> |
EmailControllerApi.downloadAttachmentWithHttpInfo(String attachmentId,
UUID emailId,
String apiKey)
Get email attachment bytes.
|
ApiResponse<Void> |
CommonActionsControllerApi.emptyInboxWithHttpInfo(UUID inboxId)
Delete all emails in an inbox
Deletes all emails
|
ApiResponse<Void> |
EmailControllerApi.forwardEmailWithHttpInfo(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email
Forward an existing email to new recipients.
|
ApiResponse<PageEmailProjection> |
AliasControllerApi.getAliasEmailsWithHttpInfo(UUID aliasId,
Integer page,
Integer size,
String sort)
Get emails for an alias
Get paginated emails for an alias by ID
|
ApiResponse<PageAlias> |
AliasControllerApi.getAliasesWithHttpInfo(Integer page,
Integer size,
String sort)
Get all email aliases you have created
Get all email aliases in paginated form
|
ApiResponse<PageThreadProjection> |
AliasControllerApi.getAliasThreadsWithHttpInfo(UUID aliasId,
Integer page,
Integer size,
String sort)
Get threads created for an alias
Returns threads created for an email alias in paginated form
|
ApiResponse<AliasDto> |
AliasControllerApi.getAliasWithHttpInfo(UUID aliasId)
Get an email alias
Get an email alias by ID
|
ApiResponse<PageContactProjection> |
ContactControllerApi.getAllContactsWithHttpInfo(Integer page,
Integer size,
String sort)
Get all contacts
|
ApiResponse<PageGroupProjection> |
GroupControllerApi.getAllGroupsWithHttpInfo(Integer page,
Integer size,
String sort)
Get all Contact Groups in paginated format
|
ApiResponse<PageInboxProjection> |
InboxControllerApi.getAllInboxesWithHttpInfo(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess)
List All Inboxes Paginated
List inboxes in paginated form.
|
ApiResponse<PageTemplateProjection> |
TemplateControllerApi.getAllTemplatesWithHttpInfo(Integer page,
Integer size,
String sort)
Get all Templates in paginated format
|
ApiResponse<PageWebhookProjection> |
WebhookControllerApi.getAllWebhooksWithHttpInfo(Integer page,
Integer size,
String sort)
List Webhooks Paginated
List webhooks in paginated form.
|
ApiResponse<AttachmentMetaData> |
EmailControllerApi.getAttachmentMetaDataWithHttpInfo(String attachmentId,
UUID emailId)
Get email attachment metadata
Returns the metadata such as name and content-type for a given attachment and email.
|
ApiResponse<List<AttachmentMetaData>> |
EmailControllerApi.getAttachmentsWithHttpInfo(UUID emailId)
Get all email attachment metadata
Returns an array of attachment metadata such as name and content-type for a given email if present.
|
ApiResponse<List<ContactProjection>> |
ContactControllerApi.getContactsWithHttpInfo()
Get all contacts
|
ApiResponse<ContactDto> |
ContactControllerApi.getContactWithHttpInfo(UUID contactId)
Get contact
|
ApiResponse<DNSLookupResults> |
MailServerControllerApi.getDnsLookupWithHttpInfo(DNSLookupOptions dnsLookupOptions)
Lookup DNS records for a domain
|
ApiResponse<List<DomainPreview>> |
DomainControllerApi.getDomainsWithHttpInfo()
Get domains
List all custom domains you have created
|
ApiResponse<DomainDto> |
DomainControllerApi.getDomainWithHttpInfo(UUID id)
Get a domain
Returns domain verification status and tokens for a given domain
|
ApiResponse<EmailContentMatchResult> |
EmailControllerApi.getEmailContentMatchWithHttpInfo(UUID emailId,
ContentMatchOptions contentMatchOptions)
Get email content regex pattern match results.
|
ApiResponse<EmailTextLinesResult> |
EmailControllerApi.getEmailHTMLQueryWithHttpInfo(UUID emailId,
String htmlSelector)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of text.
|
ApiResponse<String> |
EmailControllerApi.getEmailHTMLWithHttpInfo(UUID emailId,
Boolean decode)
Get email content as HTML
Retrieve email content as HTML response for viewing in browsers.
|
ApiResponse<PageEmailProjection> |
EmailControllerApi.getEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly)
Get all emails
By default returns all emails across all inboxes sorted by ascending created at date.
|
ApiResponse<List<EmailPreview>> |
InboxControllerApi.getEmailsWithHttpInfo(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort)
Get emails in an Inbox.
|
ApiResponse<EmailTextLinesResult> |
EmailControllerApi.getEmailTextLinesWithHttpInfo(UUID emailId,
Boolean decodeHtmlEntities,
String lineSeparator)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of strings.
|
ApiResponse<Email> |
EmailControllerApi.getEmailWithHttpInfo(UUID emailId,
Boolean decode)
Get email content
Returns a email summary object with headers and content.
|
ApiResponse<ExpirationDefaults> |
ExpiredControllerApi.getExpirationDefaultsWithHttpInfo()
Get default expiration settings
Return default times used for inbox expiration
|
ApiResponse<ExpiredInboxDto> |
ExpiredControllerApi.getExpiredInboxByInboxIdWithHttpInfo(UUID inboxId)
Get expired inbox record for a previously existing inbox
Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
|
ApiResponse<PageExpiredInboxRecordProjection> |
ExpiredControllerApi.getExpiredInboxesWithHttpInfo(Integer page,
Integer size,
String sort)
List records of expired inboxes
Inboxes created with an expiration date will expire after the given date.
|
ApiResponse<ExpiredInboxDto> |
ExpiredControllerApi.getExpiredInboxRecordWithHttpInfo(UUID expiredId)
Get an expired inbox record
Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
|
ApiResponse<List<GroupProjection>> |
GroupControllerApi.getGroupsWithHttpInfo()
Get all groups
|
ApiResponse<PageContactProjection> |
GroupControllerApi.getGroupWithContactsPaginatedWithHttpInfo(UUID groupId,
Integer page,
Integer size,
String sort)
Get group and paginated contacts belonging to it
|
ApiResponse<GroupContactsDto> |
GroupControllerApi.getGroupWithContactsWithHttpInfo(UUID groupId)
Get group and contacts belonging to it
|
ApiResponse<GroupDto> |
GroupControllerApi.getGroupWithHttpInfo(UUID groupId)
Get group
|
ApiResponse<PageEmailPreview> |
InboxControllerApi.getInboxEmailsPaginatedWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get inbox emails paginated
Get a paginated list of emails in an inbox.
|
ApiResponse<List<Inbox>> |
InboxControllerApi.getInboxesWithHttpInfo(Integer size,
String sort)
List Inboxes / Email Addresses
List the inboxes you have created.
|
ApiResponse<PageSentEmailProjection> |
InboxControllerApi.getInboxSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
ApiResponse<List<String>> |
InboxControllerApi.getInboxTagsWithHttpInfo()
Get inbox tags
Get all inbox tags
|
ApiResponse<Inbox> |
InboxControllerApi.getInboxWithHttpInfo(UUID inboxId)
Get Inbox
Returns an inbox's properties, including its email address and ID.
|
ApiResponse<IPAddressResult> |
MailServerControllerApi.getIpAddressWithHttpInfo(String name)
Get IP address for a domain
|
ApiResponse<Email> |
EmailControllerApi.getLatestEmailInInboxWithHttpInfo(UUID inboxId)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
|
ApiResponse<Email> |
EmailControllerApi.getLatestEmailWithHttpInfo(List<UUID> inboxIds)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
|
ApiResponse<PageEmailProjection> |
EmailControllerApi.getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly)
Get all organization emails
By default returns all emails across all team inboxes sorted by ascending created at date.
|
ApiResponse<PageOrganizationInboxProjection> |
InboxControllerApi.getOrganizationInboxesWithHttpInfo(Integer page,
Integer size,
String sort)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
ApiResponse<String> |
EmailControllerApi.getRawEmailContentsWithHttpInfo(UUID emailId)
Get raw email string
Returns a raw, unparsed, and unprocessed email.
|
ApiResponse<RawEmailJson> |
EmailControllerApi.getRawEmailJsonWithHttpInfo(UUID emailId)
Get raw email in JSON
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
|
ApiResponse<PageSentEmailProjection> |
SentEmailsControllerApi.getSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get all sent emails in paginated form
|
ApiResponse<SentEmailDto> |
SentEmailsControllerApi.getSentEmailWithHttpInfo(UUID id)
Get sent email receipt
|
ApiResponse<PageSentEmailProjection> |
SentEmailsControllerApi.getSentOrganizationEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get all sent organization emails in paginated form
|
ApiResponse<List<TemplateProjection>> |
TemplateControllerApi.getTemplatesWithHttpInfo()
Get all Templates
|
ApiResponse<TemplateDto> |
TemplateControllerApi.getTemplateWithHttpInfo(UUID templateId)
Get Template
|
ApiResponse<UnreadCount> |
EmailControllerApi.getUnreadEmailCountWithHttpInfo()
Get unread email count
Get number of emails unread
|
ApiResponse<List<WebhookDto>> |
WebhookControllerApi.getWebhooksWithHttpInfo(UUID inboxId)
Get all Webhooks for an Inbox
|
ApiResponse<WebhookDto> |
WebhookControllerApi.getWebhookWithHttpInfo(UUID webhookId)
Get a webhook for an Inbox
|
ApiResponse<GroupContactsDto> |
GroupControllerApi.removeContactsFromGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Remove contacts from a group
|
ApiResponse<SentEmailDto> |
AliasControllerApi.replyToAliasEmailWithHttpInfo(UUID aliasId,
UUID emailId,
ReplyToAliasEmailOptions replyToAliasEmailOptions)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc.
|
ApiResponse<SentEmailDto> |
EmailControllerApi.replyToEmailWithHttpInfo(UUID emailId,
ReplyToEmailOptions replyToEmailOptions)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc.
|
ApiResponse<SentEmailDto> |
AliasControllerApi.sendAliasEmailWithHttpInfo(UUID aliasId,
SendEmailOptions sendEmailOptions)
Send an email from an alias inbox
Send an email from an alias.
|
ApiResponse<SentEmailDto> |
InboxControllerApi.sendEmailAndConfirmWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send email and return sent confirmation
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
|
ApiResponse<Void> |
CommonActionsControllerApi.sendEmailSimpleWithHttpInfo(SimpleSendEmailOptions emailOptions)
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
|
ApiResponse<Void> |
InboxControllerApi.sendEmailWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
ApiResponse<WebhookTestResult> |
WebhookControllerApi.sendTestDataWithHttpInfo(UUID webhookId)
Send webhook test data
|
ApiResponse<Inbox> |
InboxControllerApi.setInboxFavouritedWithHttpInfo(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
ApiResponse<String> |
FormControllerApi.submitFormWithHttpInfo(String emailAddress,
String redirectTo,
String spamCheck,
String subject,
String successMessage,
String to,
String otherParameters)
Submit a form to be parsed and sent as an email to an address determined by the form fields
This endpoint allows you to submit HTML forms and receive the field values and files via email.
|
ApiResponse<Void> |
AliasControllerApi.updateAliasWithHttpInfo(UUID aliasId,
UpdateAliasOptions updateAliasOptions)
Update an email alias
|
ApiResponse<DomainDto> |
DomainControllerApi.updateDomainWithHttpInfo(UUID id,
UpdateDomainOptions updateDomainDto)
Update a domain
Update values on a domain.
|
ApiResponse<Inbox> |
InboxControllerApi.updateInboxWithHttpInfo(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox
Update editable fields on an inbox
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentBytesWithHttpInfo(String string,
String filename,
byte[] byteArray)
Upload an attachment for sending using file byte stream input octet stream.
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadOptions)
Upload an attachment for sending using base64 file encoding.
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadMultipartFormWithHttpInfo(File file,
String contentType,
String filename,
String xFilename)
Upload an attachment for sending using a Multipart Form request.
|
ApiResponse<ValidationDto> |
EmailControllerApi.validateEmailWithHttpInfo(UUID emailId)
Validate email
Validate the HTML content of email if HTML is found.
|
ApiResponse<EmailVerificationResult> |
MailServerControllerApi.verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyOptions)
Verify the existence of an email address at a given mail server.
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForEmailCountWithHttpInfo(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for and return count number of emails
If inbox contains count or more emails at time of request then return count worth of emails.
|
ApiResponse<Email> |
WaitForControllerApi.waitForLatestEmailWithHttpInfo(UUID inboxId,
Long timeout,
Boolean unreadOnly)
Fetch inbox's latest email or if empty wait for an email to arrive
Will return either the last received email or wait for an email to arrive and return that.
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForMatchingEmailWithHttpInfo(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait or return list of emails that match simple matching patterns
Perform a search of emails in an inbox with the given patterns.
|
ApiResponse<Email> |
WaitForControllerApi.waitForMatchingFirstEmailWithHttpInfo(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for or return the first email that matches proved MatchOptions array
Perform a search of emails in an inbox with the given patterns.
|
ApiResponse<Email> |
WaitForControllerApi.waitForNthEmailWithHttpInfo(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly)
Wait for or fetch the email with a given index in the inbox specified
If nth email is already present in inbox then return it.
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForWithHttpInfo(WaitForConditions waitForConditions)
Wait for conditions to be met
Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
Copyright © 2021. All rights reserved.