| Package | Description |
|---|---|
| com.mailslurp.apis | |
| com.mailslurp.clients |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<GroupContactsDto> |
GroupControllerApi.addContactsToGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContacts)
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<EmailPreview> |
EmailControllerApi.applyImapFlagOperationWithHttpInfo(UUID emailId,
ImapFlagOperationOptions imapFlagOperationOptions)
Set IMAP flags associated with a message.
|
ApiResponse<List<InboxDto>> |
BulkActionsControllerApi.bulkCreateInboxesWithHttpInfo(Integer count)
Bulk create Inboxes (email addresses)
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkDeleteInboxesWithHttpInfo(List<UUID> UUID)
Bulk Delete Inboxes
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkSendEmailsWithHttpInfo(BulkSendEmailOptions bulkSendEmailOptions)
Bulk Send Emails
|
ApiResponse<ScheduledJobDto> |
InboxControllerApi.cancelScheduledJobWithHttpInfo(UUID jobId)
Cancel a scheduled email job
Get a scheduled email job and cancel it.
|
ApiResponse<WebhookDto> |
WebhookControllerApi.createAccountWebhookWithHttpInfo(CreateWebhookOptions createWebhookOptions)
Attach a WebHook URL to an inbox
Get notified of account level events such as bounce and bounce recipient.
|
ApiResponse<AliasDto> |
AliasControllerApi.createAliasWithHttpInfo(CreateAliasOptions createAliasOptions)
Create an email alias.
|
ApiResponse<ConnectorDto> |
ConnectorControllerApi.createConnectorWithHttpInfo(CreateConnectorOptions createConnectorOptions)
Create an inbox connector
Sync emails between external mailboxes and MailSlurp inboxes
|
ApiResponse<ContactDto> |
ContactControllerApi.createContactWithHttpInfo(CreateContactOptions createContactOptions)
Create a contact
|
ApiResponse<DomainDto> |
DomainControllerApi.createDomainWithHttpInfo(CreateDomainOptions createDomainOptions)
Create Domain
Link a domain that you own with MailSlurp so you can create email addresses using it.
|
ApiResponse<EmergencyAddress> |
PhoneControllerApi.createEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions createEmergencyAddressOptions) |
ApiResponse<GroupDto> |
GroupControllerApi.createGroupWithHttpInfo(CreateGroupOptions createGroupOptions)
Create a group
|
ApiResponse<InboxRulesetDto> |
InboxControllerApi.createInboxRulesetWithHttpInfo(UUID inboxId,
CreateInboxRulesetOptions createInboxRulesetOptions)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
ApiResponse<InboxDto> |
InboxControllerApi.createInboxWithDefaultsWithHttpInfo()
Create an inbox with default options.
|
ApiResponse<InboxDto> |
InboxControllerApi.createInboxWithHttpInfo(String emailAddress,
List<String> tags,
String name,
String description,
Boolean useDomainPool,
Boolean favourite,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean allowTeamAccess,
String inboxType,
Boolean virtualInbox,
Boolean useShortAddress,
UUID domainId,
String domainName)
Create an inbox email address.
|
ApiResponse<InboxDto> |
InboxControllerApi.createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto)
Create an inbox with options.
|
ApiResponse<InboxDto> |
CommonActionsControllerApi.createNewEmailAddressWithHttpInfo(Boolean allowTeamAccess,
Boolean useDomainPool,
OffsetDateTime expiresAt,
Long expiresIn,
String emailAddress,
String inboxType,
String description,
String name,
List<String> tags,
Boolean favourite,
Boolean virtualInbox,
Boolean useShortAddress,
String domainName,
UUID domainId)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
ApiResponse<InboxForwarderDto> |
InboxForwarderControllerApi.createNewInboxForwarderWithHttpInfo(UUID inboxId,
CreateInboxForwarderOptions createInboxForwarderOptions)
Create an inbox forwarder
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
ApiResponse<InboxReplierDto> |
InboxReplierControllerApi.createNewInboxReplierWithHttpInfo(CreateInboxReplierOptions createInboxReplierOptions)
Create an inbox replier
Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving
|
ApiResponse<InboxRulesetDto> |
InboxRulesetControllerApi.createNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions createInboxRulesetOptions,
UUID inboxId)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
ApiResponse<InboxDto> |
CommonActionsControllerApi.createRandomInboxWithHttpInfo(Boolean allowTeamAccess,
Boolean useDomainPool,
OffsetDateTime expiresAt,
Long expiresIn,
String emailAddress,
String inboxType,
String description,
String name,
List<String> tags,
Boolean favourite,
Boolean virtualInbox,
Boolean useShortAddress,
String domainName,
UUID domainId)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
ApiResponse<TemplateDto> |
TemplateControllerApi.createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions)
Create a Template
Create an email template with variables for use with templated transactional emails.
|
ApiResponse<TrackingPixelDto> |
TrackingControllerApi.createTrackingPixelWithHttpInfo(CreateTrackingPixelOptions createTrackingPixelOptions)
Create tracking pixel
Create a tracking pixel.
|
ApiResponse<WebhookDto> |
WebhookControllerApi.createWebhookForPhoneNumberWithHttpInfo(UUID phoneNumberId,
CreateWebhookOptions createWebhookOptions)
Attach a WebHook URL to a phone number
Get notified whenever a phone number receives an SMS via a WebHook URL.
|
ApiResponse<WebhookDto> |
WebhookControllerApi.createWebhookWithHttpInfo(UUID inboxId,
CreateWebhookOptions createWebhookOptions)
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> |
AttachmentControllerApi.deleteAllAttachmentsWithHttpInfo()
Delete all attachments
|
ApiResponse<Void> |
EmailControllerApi.deleteAllEmailsWithHttpInfo()
Delete all emails in all inboxes.
|
ApiResponse<Void> |
InboxControllerApi.deleteAllInboxEmailsWithHttpInfo(UUID inboxId)
Delete all emails in a given inboxes.
|
ApiResponse<Void> |
InboxControllerApi.deleteAllInboxesWithHttpInfo()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
ApiResponse<Void> |
SentEmailsControllerApi.deleteAllSentEmailsWithHttpInfo()
Delete all sent email receipts
|
ApiResponse<Void> |
WebhookControllerApi.deleteAllWebhooksWithHttpInfo(OffsetDateTime before)
Delete all webhooks
|
ApiResponse<Void> |
AttachmentControllerApi.deleteAttachmentWithHttpInfo(String attachmentId)
Delete an attachment
|
ApiResponse<Void> |
ConnectorControllerApi.deleteConnectorWithHttpInfo(UUID id)
Delete an inbox connector
|
ApiResponse<Void> |
ContactControllerApi.deleteContactWithHttpInfo(UUID contactId)
Delete contact
|
ApiResponse<List<String>> |
DomainControllerApi.deleteDomainWithHttpInfo(UUID id)
Delete a domain
Delete a domain.
|
ApiResponse<Void> |
CommonActionsControllerApi.deleteEmailAddressWithHttpInfo(UUID inboxId)
Delete inbox email address by inbox id
Deletes inbox email address
|
ApiResponse<Void> |
EmailControllerApi.deleteEmailWithHttpInfo(UUID emailId)
Delete an email
Deletes an email and removes it from the inbox.
|
ApiResponse<EmptyResponseDto> |
PhoneControllerApi.deleteEmergencyAddressWithHttpInfo(UUID addressId) |
ApiResponse<Void> |
GroupControllerApi.deleteGroupWithHttpInfo(UUID groupId)
Delete group
|
ApiResponse<Void> |
InboxForwarderControllerApi.deleteInboxForwardersWithHttpInfo(UUID inboxId)
Delete inbox forwarders
Delete inbox forwarders.
|
ApiResponse<Void> |
InboxForwarderControllerApi.deleteInboxForwarderWithHttpInfo(UUID id)
Delete an inbox forwarder
Delete inbox forwarder
|
ApiResponse<Void> |
InboxReplierControllerApi.deleteInboxRepliersWithHttpInfo(UUID inboxId)
Delete inbox repliers
Delete inbox repliers.
|
ApiResponse<Void> |
InboxReplierControllerApi.deleteInboxReplierWithHttpInfo(UUID id)
Delete an inbox replier
Delete inbox replier
|
ApiResponse<Void> |
InboxRulesetControllerApi.deleteInboxRulesetsWithHttpInfo(UUID inboxId)
Delete inbox rulesets
Delete inbox rulesets.
|
ApiResponse<Void> |
InboxRulesetControllerApi.deleteInboxRulesetWithHttpInfo(UUID id)
Delete an inbox ruleset
Delete inbox ruleset
|
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> |
PhoneControllerApi.deletePhoneNumberWithHttpInfo(UUID phoneNumberId) |
ApiResponse<Void> |
SentEmailsControllerApi.deleteSentEmailWithHttpInfo(UUID id)
Delete sent email receipt
|
ApiResponse<Void> |
SmsControllerApi.deleteSmsMessagesWithHttpInfo(UUID phoneNumberId)
Delete all SMS messages
Delete all SMS messages or all messages for a given phone number
|
ApiResponse<Void> |
SmsControllerApi.deleteSmsMessageWithHttpInfo(UUID smsId)
Delete SMS message.
|
ApiResponse<Void> |
TemplateControllerApi.deleteTemplateWithHttpInfo(UUID templateId)
Delete email template
Delete template
|
ApiResponse<Void> |
WebhookControllerApi.deleteWebhookByIdWithHttpInfo(UUID webhookId)
Delete a webhook
|
ApiResponse<Void> |
WebhookControllerApi.deleteWebhookWithHttpInfo(UUID inboxId,
UUID webhookId)
Delete and disable a Webhook for an Inbox
|
ApiResponse<DescribeMailServerDomainResult> |
MailServerControllerApi.describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeDomainOptions)
Get DNS Mail Server records for a domain
|
ApiResponse<InboxExistsDto> |
InboxControllerApi.doesInboxExistWithHttpInfo(String emailAddress,
Boolean allowCatchAll)
Does inbox exist
Check if inboxes exist by email address.
|
ApiResponse<DownloadAttachmentDto> |
AttachmentControllerApi.downloadAttachmentAsBase64EncodedWithHttpInfo(String attachmentId)
Get email attachment as base64 encoded string as alternative to binary responses.
|
ApiResponse<byte[]> |
AttachmentControllerApi.downloadAttachmentAsBytesWithHttpInfo(String attachmentId)
Download attachments.
|
ApiResponse<DownloadAttachmentDto> |
EmailControllerApi.downloadAttachmentBase64WithHttpInfo(UUID emailId,
String attachmentId)
Get email attachment as base64 encoded string as an alternative to binary responses.
|
ApiResponse<byte[]> |
EmailControllerApi.downloadAttachmentWithHttpInfo(UUID emailId,
String attachmentId,
String apiKey)
Get email attachment bytes.
|
ApiResponse<byte[]> |
EmailControllerApi.downloadBodyBytesWithHttpInfo(UUID emailId)
Get email body in bytes.
|
ApiResponse<String> |
EmailControllerApi.downloadBodyWithHttpInfo(UUID emailId)
Get email body as string.
|
ApiResponse<Void> |
CommonActionsControllerApi.emptyInboxWithHttpInfo(UUID inboxId)
Delete all emails in an inbox
Deletes all emails
|
ApiResponse<List<byte[]>> |
ExportControllerApi.exportEntitiesWithHttpInfo(String exportType,
String apiKey,
String outputFormat,
String filter,
String listSeparatorToken,
Boolean excludePreviouslyExported,
OffsetDateTime createdEarliestTime,
OffsetDateTime createdOldestTime)
Export inboxes link callable via browser
|
ApiResponse<FilterBouncedRecipientsResult> |
BounceControllerApi.filterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions)
Filter a list of email recipients and remove those who have bounced
Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
|
ApiResponse<FlushExpiredInboxesResult> |
InboxControllerApi.flushExpiredWithHttpInfo(OffsetDateTime before)
Remove expired inboxes
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
|
ApiResponse<SentEmailDto> |
EmailControllerApi.forwardEmailWithHttpInfo(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email to recipients
Forward an existing email to new recipients.
|
ApiResponse<PageEmailProjection> |
AliasControllerApi.getAliasEmailsWithHttpInfo(UUID aliasId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get emails for an alias
Get paginated emails for an alias by ID
|
ApiResponse<PageAlias> |
AliasControllerApi.getAliasesWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
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,
OffsetDateTime since,
OffsetDateTime before)
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<PageWebhookProjection> |
WebhookControllerApi.getAllAccountWebhooksWithHttpInfo(Integer page,
Integer size,
String sort,
String eventType,
OffsetDateTime since,
OffsetDateTime before)
List account webhooks Paginated
List account webhooks in paginated form.
|
ApiResponse<PageConnectorSyncEvents> |
ConnectorControllerApi.getAllConnectorSyncEventsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all inbox connector sync events
|
ApiResponse<PageContactProjection> |
ContactControllerApi.getAllContactsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all contacts
|
ApiResponse<PageGroupProjection> |
GroupControllerApi.getAllGroupsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all Contact Groups in paginated format
|
ApiResponse<PageInboxProjection> |
InboxControllerApi.getAllInboxesWithHttpInfo(Integer page,
Integer size,
String sort,
Boolean favourite,
String search,
String tag,
Boolean teamAccess,
OffsetDateTime since,
OffsetDateTime before,
String inboxType,
UUID domainId)
List All Inboxes Paginated
List inboxes in paginated form.
|
ApiResponse<PageMissedEmailProjection> |
MissedEmailControllerApi.getAllMissedEmailsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
UUID inboxId)
Get all MissedEmails in paginated format
|
ApiResponse<PageScheduledJobs> |
InboxControllerApi.getAllScheduledJobsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all scheduled email sending jobs for account
Schedule sending of emails using scheduled jobs.
|
ApiResponse<PageTrackingPixelProjection> |
SentEmailsControllerApi.getAllSentTrackingPixelsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all sent email tracking pixels in paginated form
|
ApiResponse<PageTemplateProjection> |
TemplateControllerApi.getAllTemplatesWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
List templates
Get all templates in paginated format
|
ApiResponse<PageTrackingPixelProjection> |
TrackingControllerApi.getAllTrackingPixelsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get tracking pixels
List tracking pixels in paginated form
|
ApiResponse<PageUnknownMissedEmailProjection> |
MissedEmailControllerApi.getAllUnknownMissedEmailsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
UUID inboxId)
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.
|
ApiResponse<PageWebhookResult> |
WebhookControllerApi.getAllWebhookResultsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
Boolean unseenOnly)
Get results for all webhooks
|
ApiResponse<PageWebhookProjection> |
WebhookControllerApi.getAllWebhooksWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
UUID inboxId,
UUID phoneId,
OffsetDateTime before)
List Webhooks Paginated
List webhooks in paginated form.
|
ApiResponse<AttachmentMetaData> |
AttachmentControllerApi.getAttachmentInfoWithHttpInfo(String attachmentId)
Get email attachment metadata information
Returns the metadata for an attachment.
|
ApiResponse<AttachmentMetaData> |
EmailControllerApi.getAttachmentMetaDataWithHttpInfo(UUID emailId,
String attachmentId)
Get email attachment metadata.
|
ApiResponse<PageAttachmentEntity> |
AttachmentControllerApi.getAttachmentsWithHttpInfo(Integer page,
Integer size,
String sort,
String fileNameFilter,
OffsetDateTime since,
OffsetDateTime before)
Get email attachments
Get all attachments in paginated response.
|
ApiResponse<AttachmentEntity> |
AttachmentControllerApi.getAttachmentWithHttpInfo(String attachmentId)
Get an attachment entity
|
ApiResponse<PageBouncedEmail> |
BounceControllerApi.getBouncedEmailsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get paginated list of bounced emails.
|
ApiResponse<BouncedEmailDto> |
BounceControllerApi.getBouncedEmailWithHttpInfo(UUID id)
Get a bounced email.
|
ApiResponse<PageBouncedRecipients> |
BounceControllerApi.getBouncedRecipientsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get paginated list of bounced recipients.
|
ApiResponse<BouncedRecipientDto> |
BounceControllerApi.getBouncedRecipientWithHttpInfo(UUID id)
Get a bounced email.
|
ApiResponse<PageComplaint> |
BounceControllerApi.getComplaintsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get paginated list of complaints.
|
ApiResponse<PageConnector> |
ConnectorControllerApi.getConnectorsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get inbox connectors
List inbox connectors that sync external emails to MailSlurp inboxes
|
ApiResponse<PageConnectorSyncEvents> |
ConnectorControllerApi.getConnectorSyncEventsWithHttpInfo(UUID id,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get an inbox connector sync events
|
ApiResponse<ConnectorSyncEventDto> |
ConnectorControllerApi.getConnectorSyncEventWithHttpInfo(UUID id)
Get an inbox connector sync event
|
ApiResponse<ConnectorDto> |
ConnectorControllerApi.getConnectorWithHttpInfo(UUID id)
Get an inbox connector
|
ApiResponse<List<ContactProjection>> |
ContactControllerApi.getContactsWithHttpInfo()
Get all contacts
|
ApiResponse<List<byte[]>> |
ContactControllerApi.getContactVCardWithHttpInfo(UUID contactId)
Get contact vCard vcf file
|
ApiResponse<ContactDto> |
ContactControllerApi.getContactWithHttpInfo(UUID contactId)
Get contact
|
ApiResponse<PageDeliveryStatus> |
InboxControllerApi.getDeliveryStatusesByInboxIdWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all email delivery statuses for an inbox
|
ApiResponse<DNSLookupResults> |
MailServerControllerApi.getDnsLookupWithHttpInfo(DNSLookupOptions dnSLookupOptions)
Lookup DNS records for a domain
|
ApiResponse<DomainIssuesDto> |
DomainControllerApi.getDomainIssuesWithHttpInfo()
Get domain issues
List domain issues for domains you have created
|
ApiResponse<List<DomainPreview>> |
DomainControllerApi.getDomainsWithHttpInfo()
Get domains
List all custom domains you have created
|
ApiResponse<InboxDto> |
DomainControllerApi.getDomainWildcardCatchAllInboxWithHttpInfo(UUID id)
Get catch all wild card inbox for domain
Get the catch all inbox for a domain for missed emails
|
ApiResponse<DomainDto> |
DomainControllerApi.getDomainWithHttpInfo(UUID id,
Boolean checkForErrors)
Get a domain
Returns domain verification status and tokens for a given domain
|
ApiResponse<List<AttachmentMetaData>> |
EmailControllerApi.getEmailAttachmentsWithHttpInfo(UUID emailId)
Get all email attachment metadata.
|
ApiResponse<EmailContentMatchResult> |
EmailControllerApi.getEmailContentMatchWithHttpInfo(UUID emailId,
ContentMatchOptions contentMatchOptions)
Get email content regex pattern match results.
|
ApiResponse<CountDto> |
EmailControllerApi.getEmailCountWithHttpInfo()
Get email count
|
ApiResponse<EmailHtmlDto> |
EmailControllerApi.getEmailHTMLJsonWithHttpInfo(UUID emailId,
Boolean decode)
Get email content as HTML in JSON wrapper.
|
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.
|
ApiResponse<EmailLinksResult> |
EmailControllerApi.getEmailLinksWithHttpInfo(UUID emailId)
Parse and return list of links found in an email (only works for HTML content)
HTML parsing uses JSoup and UNIX line separators.
|
ApiResponse<EmailPreviewUrls> |
EmailControllerApi.getEmailPreviewURLsWithHttpInfo(UUID emailId)
Get email URLs for viewing in browser or downloading
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
ApiResponse<PageEmailProjection> |
EmailControllerApi.getEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all emails in all inboxes in paginated form.
|
ApiResponse<List<EmailPreview>> |
InboxControllerApi.getEmailsWithHttpInfo(UUID inboxId,
Integer size,
Integer limit,
String sort,
Long retryTimeout,
Long delayTimeout,
Long minCount,
Boolean unreadOnly,
OffsetDateTime before,
OffsetDateTime since)
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 including headers and body.
|
ApiResponse<List<EmergencyAddressDto>> |
PhoneControllerApi.getEmergencyAddressesWithHttpInfo() |
ApiResponse<EmergencyAddress> |
PhoneControllerApi.getEmergencyAddressWithHttpInfo(UUID addressId) |
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,
OffsetDateTime since,
OffsetDateTime before)
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<ExportLink> |
ExportControllerApi.getExportLinkWithHttpInfo(String exportType,
ExportOptions exportOptions,
String apiKey)
Get export link
|
ApiResponse<GravatarUrl> |
EmailControllerApi.getGravatarUrlForEmailAddressWithHttpInfo(String emailAddress,
String size)
Get gravatar url for email address
|
ApiResponse<List<GroupProjection>> |
GroupControllerApi.getGroupsWithHttpInfo()
Get all groups
|
ApiResponse<PageContactProjection> |
GroupControllerApi.getGroupWithContactsPaginatedWithHttpInfo(UUID groupId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
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<ImapSmtpAccessDetails> |
InboxControllerApi.getImapSmtpAccessWithHttpInfo(UUID inboxId)
Get IMAP and SMTP access usernames and passwords
|
ApiResponse<InboxByEmailAddressResult> |
InboxControllerApi.getInboxByEmailAddressWithHttpInfo(String emailAddress)
Search for an inbox with the provided email address
Get a inbox result by email address
|
ApiResponse<InboxByNameResult> |
InboxControllerApi.getInboxByNameWithHttpInfo(String name)
Search for an inbox with the given name
Get a inbox result by name
|
ApiResponse<CountDto> |
InboxControllerApi.getInboxCountWithHttpInfo()
Get total inbox count
|
ApiResponse<CountDto> |
InboxControllerApi.getInboxEmailCountWithHttpInfo(UUID inboxId)
Get email count in inbox
|
ApiResponse<PageEmailPreview> |
InboxControllerApi.getInboxEmailsPaginatedWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get inbox emails paginated
Get a paginated list of emails in an inbox.
|
ApiResponse<List<InboxDto>> |
InboxControllerApi.getInboxesWithHttpInfo(Integer size,
String sort,
OffsetDateTime since,
Boolean excludeCatchAllInboxes,
OffsetDateTime before)
Deprecated.
|
ApiResponse<PageInboxForwarderEvents> |
InboxForwarderControllerApi.getInboxForwarderEventsWithHttpInfo(UUID id,
Integer page,
Integer size,
String sort)
Get an inbox forwarder event list
Get inbox ruleset events
|
ApiResponse<PageInboxForwarderDto> |
InboxForwarderControllerApi.getInboxForwardersWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List inbox forwarders
List all forwarders attached to an inbox
|
ApiResponse<InboxForwarderDto> |
InboxForwarderControllerApi.getInboxForwarderWithHttpInfo(UUID id)
Get an inbox forwarder
Get inbox ruleset
|
ApiResponse<InboxIdsResult> |
InboxControllerApi.getInboxIdsWithHttpInfo()
Get all inbox IDs
Get list of inbox IDs
|
ApiResponse<PageInboxReplierEvents> |
InboxReplierControllerApi.getInboxReplierEventsWithHttpInfo(UUID id,
Integer page,
Integer size,
String sort)
Get an inbox replier event list
Get inbox ruleset events
|
ApiResponse<PageInboxReplierDto> |
InboxReplierControllerApi.getInboxRepliersWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
List inbox repliers
List all repliers attached to an inbox
|
ApiResponse<InboxReplierDto> |
InboxReplierControllerApi.getInboxReplierWithHttpInfo(UUID id)
Get an inbox replier
Get inbox ruleset
|
ApiResponse<PageInboxRulesetDto> |
InboxRulesetControllerApi.getInboxRulesetsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List inbox rulesets
List all rulesets attached to an inbox
|
ApiResponse<InboxRulesetDto> |
InboxRulesetControllerApi.getInboxRulesetWithHttpInfo(UUID id)
Get an inbox ruleset
Get inbox ruleset
|
ApiResponse<PageSentEmailProjection> |
InboxControllerApi.getInboxSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
ApiResponse<List<String>> |
InboxControllerApi.getInboxTagsWithHttpInfo()
Get inbox tags
Get all inbox tags
|
ApiResponse<PageWebhookProjection> |
WebhookControllerApi.getInboxWebhooksPaginatedWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get paginated webhooks for an Inbox
|
ApiResponse<InboxDto> |
InboxControllerApi.getInboxWithHttpInfo(UUID inboxId)
Get Inbox.
|
ApiResponse<IPAddressResult> |
MailServerControllerApi.getIpAddressWithHttpInfo(String name)
Get IP address for a domain
|
ApiResponse<String> |
UserControllerApi.getJsonPropertyAsStringWithHttpInfo(String property,
Object body)
Utility function to extract properties from JSON objects in language where this is cumbersome.
|
ApiResponse<JSONSchemaDto> |
WebhookControllerApi.getJsonSchemaForWebhookEventWithHttpInfo(String event)
Get JSON Schema definition for webhook payload by event
|
ApiResponse<JSONSchemaDto> |
WebhookControllerApi.getJsonSchemaForWebhookPayloadWithHttpInfo(UUID webhookId)
Get JSON Schema definition for webhook payload
|
ApiResponse<Email> |
EmailControllerApi.getLatestEmailInInbox1WithHttpInfo(UUID inboxId)
Get latest email in an inbox.
|
ApiResponse<Email> |
InboxControllerApi.getLatestEmailInInboxWithHttpInfo(UUID inboxId,
Long timeoutMillis)
Get latest email in an inbox.
|
ApiResponse<Email> |
EmailControllerApi.getLatestEmailWithHttpInfo(List<UUID> inboxIds)
Get latest email in all inboxes.
|
ApiResponse<PageListUnsubscribeRecipients> |
BounceControllerApi.getListUnsubscribeRecipientsWithHttpInfo(Integer page,
Integer size,
String sort,
UUID domainId)
Get paginated list of unsubscribed recipients.
|
ApiResponse<MissedEmailDto> |
MissedEmailControllerApi.getMissedEmailWithHttpInfo(UUID missedEmailId)
Get MissedEmail
List emails that were missed due to plan limits.
|
ApiResponse<PageEmailProjection> |
EmailControllerApi.getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all organization emails.
|
ApiResponse<PageOrganizationInboxProjection> |
InboxControllerApi.getOrganizationInboxesWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
ApiResponse<PagePhoneNumberProjection> |
PhoneControllerApi.getPhoneNumbersWithHttpInfo(String phoneCountry,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before) |
ApiResponse<PageWebhookProjection> |
WebhookControllerApi.getPhoneNumberWebhooksPaginatedWithHttpInfo(UUID phoneId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get paginated webhooks for a phone number
|
ApiResponse<PhoneNumberDto> |
PhoneControllerApi.getPhoneNumberWithHttpInfo(UUID phoneNumberId) |
ApiResponse<List<PhonePlanDto>> |
PhoneControllerApi.getPhonePlansWithHttpInfo() |
ApiResponse<String> |
EmailControllerApi.getRawEmailContentsWithHttpInfo(UUID emailId)
Get raw email string.
|
ApiResponse<RawEmailJson> |
EmailControllerApi.getRawEmailJsonWithHttpInfo(UUID emailId)
Get raw email in JSON.
|
ApiResponse<String> |
SentEmailsControllerApi.getRawSentEmailContentsWithHttpInfo(UUID emailId)
Get raw sent email string.
|
ApiResponse<RawEmailJson> |
SentEmailsControllerApi.getRawSentEmailJsonWithHttpInfo(UUID emailId)
Get raw sent email in JSON.
|
ApiResponse<PageScheduledJobs> |
InboxControllerApi.getScheduledJobsByInboxIdWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all scheduled email sending jobs for the inbox
Schedule sending of emails using scheduled jobs.
|
ApiResponse<ScheduledJobDto> |
InboxControllerApi.getScheduledJobWithHttpInfo(UUID jobId)
Get a scheduled email job
Get a scheduled email job details.
|
ApiResponse<PageDeliveryStatus> |
SentEmailsControllerApi.getSentDeliveryStatusesBySentIdWithHttpInfo(UUID sentId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all sent email delivery statuses
|
ApiResponse<PageDeliveryStatus> |
SentEmailsControllerApi.getSentDeliveryStatusesWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all sent email delivery statuses
|
ApiResponse<DeliveryStatusDto> |
SentEmailsControllerApi.getSentDeliveryStatusWithHttpInfo(UUID deliveryId)
Get a sent email delivery status
|
ApiResponse<String> |
SentEmailsControllerApi.getSentEmailHTMLContentWithHttpInfo(UUID id)
Get sent email HTML content
|
ApiResponse<EmailPreviewUrls> |
SentEmailsControllerApi.getSentEmailPreviewURLsWithHttpInfo(UUID id)
Get sent email URL for viewing in browser or downloading
Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
|
ApiResponse<PageSentEmailProjection> |
SentEmailsControllerApi.getSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all sent emails in paginated form
|
ApiResponse<PageSentEmailWithQueueProjection> |
SentEmailsControllerApi.getSentEmailsWithQueueResultsWithHttpInfo(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get results of email sent with queues in paginated form
|
ApiResponse<PageTrackingPixelProjection> |
SentEmailsControllerApi.getSentEmailTrackingPixelsWithHttpInfo(UUID id,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all tracking pixels for a sent email 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,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all sent organization emails in paginated form
|
ApiResponse<PageSmsProjection> |
SmsControllerApi.getSmsMessagesPaginatedWithHttpInfo(UUID phoneNumber,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
OffsetDateTime since,
OffsetDateTime before)
Get all SMS messages in all phone numbers in paginated form.
|
ApiResponse<SmsDto> |
SmsControllerApi.getSmsMessageWithHttpInfo(UUID smsId)
Get SMS content including body.
|
ApiResponse<String> |
TemplateControllerApi.getTemplatePreviewHtmlWithHttpInfo(UUID templateId)
Get template preview HTML
Get email template preview with passed template variables in HTML format for browsers.
|
ApiResponse<TemplatePreview> |
TemplateControllerApi.getTemplatePreviewJsonWithHttpInfo(UUID templateId)
Get template preview Json
Get email template preview with passed template variables in JSON format.
|
ApiResponse<List<TemplateProjection>> |
TemplateControllerApi.getTemplatesWithHttpInfo()
List templates
Get all templates
|
ApiResponse<TemplateDto> |
TemplateControllerApi.getTemplateWithHttpInfo(UUID templateId)
Get template
Get email template
|
ApiResponse<WebhookBounceRecipientPayload> |
WebhookControllerApi.getTestWebhookPayloadBounceRecipientWithHttpInfo()
Get webhook test payload for bounce recipient
|
ApiResponse<WebhookBouncePayload> |
WebhookControllerApi.getTestWebhookPayloadBounceWithHttpInfo()
Get webhook test payload for bounce
|
ApiResponse<WebhookDeliveryStatusPayload> |
WebhookControllerApi.getTestWebhookPayloadDeliveryStatusWithHttpInfo()
Get webhook test payload for delivery status event
|
ApiResponse<WebhookEmailOpenedPayload> |
WebhookControllerApi.getTestWebhookPayloadEmailOpenedWithHttpInfo()
Get webhook test payload for email opened event
|
ApiResponse<WebhookEmailReadPayload> |
WebhookControllerApi.getTestWebhookPayloadEmailReadWithHttpInfo()
Get webhook test payload for email opened event
|
ApiResponse<AbstractWebhookPayload> |
WebhookControllerApi.getTestWebhookPayloadForWebhookWithHttpInfo(UUID webhookId)
Get example payload for webhook
|
ApiResponse<WebhookNewAttachmentPayload> |
WebhookControllerApi.getTestWebhookPayloadNewAttachmentWithHttpInfo()
Get webhook test payload for new attachment event
|
ApiResponse<WebhookNewContactPayload> |
WebhookControllerApi.getTestWebhookPayloadNewContactWithHttpInfo()
Get webhook test payload for new contact event
|
ApiResponse<WebhookNewEmailPayload> |
WebhookControllerApi.getTestWebhookPayloadNewEmailWithHttpInfo()
Get webhook test payload for new email event
|
ApiResponse<WebhookNewSmsPayload> |
WebhookControllerApi.getTestWebhookPayloadNewSmsWithHttpInfo()
Get webhook test payload for new sms event
|
ApiResponse<AbstractWebhookPayload> |
WebhookControllerApi.getTestWebhookPayloadWithHttpInfo(String eventName)
Get test webhook payload example.
|
ApiResponse<TrackingPixelDto> |
TrackingControllerApi.getTrackingPixelWithHttpInfo(UUID id)
Get pixel
|
ApiResponse<UnreadCount> |
EmailControllerApi.getUnreadEmailCountWithHttpInfo()
Get unread email count
Get number of emails unread.
|
ApiResponse<UnreadCount> |
SmsControllerApi.getUnreadSmsCountWithHttpInfo()
Get unread SMS count
Get number of SMS unread.
|
ApiResponse<UserInfoDto> |
UserControllerApi.getUserInfoWithHttpInfo()
Get account information for your user
|
ApiResponse<PageEmailValidationRequest> |
EmailVerificationControllerApi.getValidationRequestsWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
Boolean isValid)
Validate a list of email addresses.
|
ApiResponse<UnseenErrorCountDto> |
WebhookControllerApi.getWebhookResultsUnseenErrorCountWithHttpInfo()
Get count of unseen webhook results with error status
|
ApiResponse<PageWebhookResult> |
WebhookControllerApi.getWebhookResultsWithHttpInfo(UUID webhookId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
Boolean unseenOnly)
Get a webhook results for a webhook
|
ApiResponse<WebhookResultDto> |
WebhookControllerApi.getWebhookResultWithHttpInfo(UUID webhookResultId)
Get a webhook result for a webhook
|
ApiResponse<List<WebhookDto>> |
WebhookControllerApi.getWebhooksWithHttpInfo(UUID inboxId)
Deprecated.
|
ApiResponse<WebhookDto> |
WebhookControllerApi.getWebhookWithHttpInfo(UUID webhookId)
Get a webhook
|
ApiResponse<PageInboxRulesetDto> |
InboxControllerApi.listInboxRulesetsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List inbox rulesets
List all rulesets attached to an inbox
|
ApiResponse<PageTrackingPixelProjection> |
InboxControllerApi.listInboxTrackingPixelsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List inbox tracking pixels
List all tracking pixels sent from an inbox
|
ApiResponse<EmailPreview> |
EmailControllerApi.markAsReadWithHttpInfo(UUID emailId,
Boolean read)
Mark an email as read on unread
Marks an email as read or unread.
|
ApiResponse<WebhookRedriveResult> |
WebhookControllerApi.redriveWebhookResultWithHttpInfo(UUID webhookResultId)
Get a webhook result and try to resend the original webhook payload
Allows you to resend a webhook payload that was already sent.
|
ApiResponse<GroupContactsDto> |
GroupControllerApi.removeContactsFromGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContacts)
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<Void> |
MissedEmailControllerApi.restoreMissedEmailsWithHttpInfo()
Restore missed emails
If emails were missed due to a plan limit they are saved as missed emails.
|
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 a link to the sent object created for it.
|
ApiResponse<Void> |
CommonActionsControllerApi.sendEmailSimpleWithHttpInfo(SimpleSendEmailOptions simpleSendEmailOptions)
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
|
ApiResponse<Void> |
EmailControllerApi.sendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions,
UUID inboxId,
Boolean useDomainPool,
Boolean virtualSend)
Send email
Alias for `InboxController.sendEmail` method - see original method for full details.
|
ApiResponse<Void> |
InboxControllerApi.sendEmailWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
ApiResponse<Void> |
InboxControllerApi.sendEmailWithQueueWithHttpInfo(UUID inboxId,
Boolean validateBeforeEnqueue,
SendEmailOptions sendEmailOptions)
Send email with queue
Send an email using a queue.
|
ApiResponse<SentEmailDto> |
InboxControllerApi.sendSmtpEnvelopeWithHttpInfo(UUID inboxId,
SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions)
Send email using an SMTP mail envelope and message body and return sent confirmation
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
|
ApiResponse<WebhookTestResult> |
WebhookControllerApi.sendTestDataWithHttpInfo(UUID webhookId)
Send webhook test data
|
ApiResponse<Void> |
InboxControllerApi.sendTestEmailWithHttpInfo(UUID inboxId)
Send a test email to inbox
Send an inbox a test email to test email receiving is working
|
ApiResponse<ScheduledJobDto> |
InboxControllerApi.sendWithScheduleWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions,
OffsetDateTime sendAtTimestamp,
Long sendAtNowPlusSeconds,
Boolean validateBeforeEnqueue)
Send email with with delay or schedule
Send an email using a delay.
|
ApiResponse<InboxDto> |
InboxControllerApi.setInboxFavouritedWithHttpInfo(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
ApiResponse<String> |
FormControllerApi.submitFormWithHttpInfo(String to,
String subject,
String redirectTo,
String emailAddress,
String successMessage,
String spamCheck,
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<ConnectorSyncRequestResult> |
ConnectorControllerApi.syncConnectorWithHttpInfo(UUID id)
Sync an inbox connector
|
ApiResponse<InboxForwarderTestResult> |
InboxForwarderControllerApi.testInboxForwardersForInboxWithHttpInfo(UUID inboxId,
InboxForwarderTestOptions inboxForwarderTestOptions)
Test inbox forwarders for inbox
Test inbox forwarders for inbox
|
ApiResponse<InboxForwarderTestResult> |
InboxForwarderControllerApi.testInboxForwarderWithHttpInfo(UUID id,
InboxForwarderTestOptions inboxForwarderTestOptions)
Test an inbox forwarder
Test an inbox forwarder
|
ApiResponse<InboxRulesetTestResult> |
InboxRulesetControllerApi.testInboxRulesetsForInboxWithHttpInfo(UUID inboxId,
InboxRulesetTestOptions inboxRulesetTestOptions)
Test inbox rulesets for inbox
Test inbox rulesets for inbox
|
ApiResponse<InboxRulesetTestResult> |
InboxRulesetControllerApi.testInboxRulesetWithHttpInfo(UUID id,
InboxRulesetTestOptions inboxRulesetTestOptions)
Test an inbox ruleset
Test an inbox ruleset
|
ApiResponse<InboxForwarderTestResult> |
InboxForwarderControllerApi.testNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions testNewInboxForwarderOptions)
Test new inbox forwarder
Test new inbox forwarder
|
ApiResponse<InboxRulesetTestResult> |
InboxRulesetControllerApi.testNewInboxRulesetWithHttpInfo(TestNewInboxRulesetOptions testNewInboxRulesetOptions)
Test new inbox ruleset
Test new inbox ruleset
|
ApiResponse<Void> |
PhoneControllerApi.testPhoneNumberSendSmsWithHttpInfo(UUID phoneNumberId,
TestPhoneNumberOptions testPhoneNumberOptions,
String xTestId) |
ApiResponse<AliasDto> |
AliasControllerApi.updateAliasWithHttpInfo(UUID aliasId,
UpdateAliasOptions updateAliasOptions)
Update an email alias
|
ApiResponse<ConnectorDto> |
ConnectorControllerApi.updateConnectorWithHttpInfo(UUID id,
CreateConnectorOptions createConnectorOptions)
Update an inbox connector
|
ApiResponse<DomainDto> |
DomainControllerApi.updateDomainWithHttpInfo(UUID id,
UpdateDomainOptions updateDomainOptions)
Update a domain
Update values on a domain.
|
ApiResponse<InboxForwarderDto> |
InboxForwarderControllerApi.updateInboxForwarderWithHttpInfo(UUID id,
CreateInboxForwarderOptions createInboxForwarderOptions)
Update an inbox forwarder
Update inbox ruleset
|
ApiResponse<InboxReplierDto> |
InboxReplierControllerApi.updateInboxReplierWithHttpInfo(UUID id,
UpdateInboxReplierOptions updateInboxReplierOptions)
Update an inbox replier
Update inbox ruleset
|
ApiResponse<InboxDto> |
InboxControllerApi.updateInboxWithHttpInfo(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox.
|
ApiResponse<TemplateDto> |
TemplateControllerApi.updateTemplateWithHttpInfo(UUID templateId,
CreateTemplateOptions createTemplateOptions)
Update template
Update email template
|
ApiResponse<WebhookDto> |
WebhookControllerApi.updateWebhookHeadersWithHttpInfo(UUID webhookId,
WebhookHeaders webhookHeaders)
Update a webhook request headers
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentBytesWithHttpInfo(UploadAttachmentBytesRequest uploadAttachmentBytesRequest,
String contentType,
String filename)
Upload an attachment for sending using file byte stream input octet stream.
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadAttachmentOptions)
Upload an attachment for sending using base64 file encoding.
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadMultipartFormWithHttpInfo(String contentType,
String filename,
String xFilename,
UploadMultipartFormRequest uploadMultipartFormRequest)
Upload an attachment for sending using a Multipart Form request.
|
ApiResponse<ValidateEmailAddressListResult> |
EmailVerificationControllerApi.validateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions validateEmailAddressListOptions)
Validate a list of email addresses.
|
ApiResponse<ValidationDto> |
EmailControllerApi.validateEmailWithHttpInfo(UUID emailId)
Validate email HTML contents
Validate the HTML content of email if HTML is found.
|
ApiResponse<EmailVerificationResult> |
MailServerControllerApi.verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyEmailAddressOptions)
Deprecated.
|
ApiResponse<VerifyWebhookSignatureResults> |
WebhookControllerApi.verifyWebhookSignatureWithHttpInfo(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions)
Verify a webhook payload signature
Verify a webhook payload using the messageId and signature.
|
ApiResponse<DeliveryStatusDto> |
SentEmailsControllerApi.waitForDeliveryStatusesWithHttpInfo(UUID sentId,
UUID inboxId,
Long timeout,
Integer index,
OffsetDateTime since,
OffsetDateTime before)
Wait for delivery statuses
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForEmailCountWithHttpInfo(UUID inboxId,
Integer count,
Long timeout,
Boolean unreadOnly,
OffsetDateTime before,
OffsetDateTime since,
String sort,
Long delay)
Wait for and return count number of emails.
|
ApiResponse<Email> |
WaitForControllerApi.waitForLatestEmailWithHttpInfo(UUID inboxId,
Long timeout,
Boolean unreadOnly,
OffsetDateTime before,
OffsetDateTime since,
String sort,
Long delay)
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<SmsDto> |
WaitForControllerApi.waitForLatestSmsWithHttpInfo(WaitForSingleSmsOptions waitForSingleSmsOptions)
Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForMatchingEmailsWithHttpInfo(UUID inboxId,
Integer count,
MatchOptions matchOptions,
OffsetDateTime before,
OffsetDateTime since,
String sort,
Long delay,
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(UUID inboxId,
MatchOptions matchOptions,
Long timeout,
Boolean unreadOnly,
OffsetDateTime since,
OffsetDateTime before,
String sort,
Long delay)
Wait for or return the first email that matches provided 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,
OffsetDateTime since,
OffsetDateTime before,
String sort,
Long delay)
Wait for or fetch the email with a given index in the inbox specified.
|
ApiResponse<MissedEmailDto> |
MissedEmailControllerApi.waitForNthMissedEmailWithHttpInfo(Integer index,
UUID inboxId,
Long timeout,
OffsetDateTime since,
OffsetDateTime before)
Wait for Nth missed email
Wait for 0 based index missed email
|
ApiResponse<List<SmsPreview>> |
WaitForControllerApi.waitForSmsWithHttpInfo(WaitForSmsConditions waitForSmsConditions)
Wait for an SMS message to match the provided filter conditions such as body contains keyword.
|
ApiResponse<List<EmailPreview>> |
WaitForControllerApi.waitForWithHttpInfo(WaitForConditions waitForConditions)
Wait for an email to match the provided filter conditions such as subject contains keyword.
|
| 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 © 2023. All rights reserved.