| Package | Description |
|---|---|
| com.mailslurp.apis | |
| com.mailslurp.clients |
| Modifier and Type | Method and Description |
|---|---|
GroupContactsDto |
GroupControllerApi.addContactsToGroup(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Add contacts to a group
|
okhttp3.Call |
GroupControllerApi.addContactsToGroupAsync(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback<GroupContactsDto> _callback)
Add contacts to a group (asynchronously)
|
okhttp3.Call |
GroupControllerApi.addContactsToGroupCall(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback _callback)
Build call for addContactsToGroup
|
ApiResponse<GroupContactsDto> |
GroupControllerApi.addContactsToGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Add contacts to a group
|
DomainDto |
DomainControllerApi.addDomainWildcardCatchAll(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
|
okhttp3.Call |
DomainControllerApi.addDomainWildcardCatchAllAsync(UUID id,
ApiCallback<DomainDto> _callback)
Add catch all wild card inbox to domain (asynchronously)
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
|
okhttp3.Call |
DomainControllerApi.addDomainWildcardCatchAllCall(UUID id,
ApiCallback _callback)
Build call for addDomainWildcardCatchAll
|
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
|
List<Inbox> |
BulkActionsControllerApi.bulkCreateInboxes(Integer count)
Bulk create Inboxes (email addresses)
|
okhttp3.Call |
BulkActionsControllerApi.bulkCreateInboxesAsync(Integer count,
ApiCallback<List<Inbox>> _callback)
Bulk create Inboxes (email addresses) (asynchronously)
|
okhttp3.Call |
BulkActionsControllerApi.bulkCreateInboxesCall(Integer count,
ApiCallback _callback)
Build call for bulkCreateInboxes
|
ApiResponse<List<Inbox>> |
BulkActionsControllerApi.bulkCreateInboxesWithHttpInfo(Integer count)
Bulk create Inboxes (email addresses)
|
void |
BulkActionsControllerApi.bulkDeleteInboxes(List<UUID> ids)
Bulk Delete Inboxes
|
okhttp3.Call |
BulkActionsControllerApi.bulkDeleteInboxesAsync(List<UUID> ids,
ApiCallback<Void> _callback)
Bulk Delete Inboxes (asynchronously)
|
okhttp3.Call |
BulkActionsControllerApi.bulkDeleteInboxesCall(List<UUID> ids,
ApiCallback _callback)
Build call for bulkDeleteInboxes
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkDeleteInboxesWithHttpInfo(List<UUID> ids)
Bulk Delete Inboxes
|
void |
BulkActionsControllerApi.bulkSendEmails(BulkSendEmailOptions bulkSendEmailOptions)
Bulk Send Emails
|
okhttp3.Call |
BulkActionsControllerApi.bulkSendEmailsAsync(BulkSendEmailOptions bulkSendEmailOptions,
ApiCallback<Void> _callback)
Bulk Send Emails (asynchronously)
|
okhttp3.Call |
BulkActionsControllerApi.bulkSendEmailsCall(BulkSendEmailOptions bulkSendEmailOptions,
ApiCallback _callback)
Build call for bulkSendEmails
|
ApiResponse<Void> |
BulkActionsControllerApi.bulkSendEmailsWithHttpInfo(BulkSendEmailOptions bulkSendEmailOptions)
Bulk Send Emails
|
AliasDto |
AliasControllerApi.createAlias(CreateAliasOptions createAliasOptions)
Create an email alias.
|
okhttp3.Call |
AliasControllerApi.createAliasAsync(CreateAliasOptions createAliasOptions,
ApiCallback<AliasDto> _callback)
Create an email alias.
|
okhttp3.Call |
AliasControllerApi.createAliasCall(CreateAliasOptions createAliasOptions,
ApiCallback _callback)
Build call for createAlias
|
ApiResponse<AliasDto> |
AliasControllerApi.createAliasWithHttpInfo(CreateAliasOptions createAliasOptions)
Create an email alias.
|
ContactDto |
ContactControllerApi.createContact(CreateContactOptions createContactOptions)
Create a contact
|
okhttp3.Call |
ContactControllerApi.createContactAsync(CreateContactOptions createContactOptions,
ApiCallback<ContactDto> _callback)
Create a contact (asynchronously)
|
okhttp3.Call |
ContactControllerApi.createContactCall(CreateContactOptions createContactOptions,
ApiCallback _callback)
Build call for createContact
|
ApiResponse<ContactDto> |
ContactControllerApi.createContactWithHttpInfo(CreateContactOptions createContactOptions)
Create a contact
|
DomainDto |
DomainControllerApi.createDomain(CreateDomainOptions domainOptions)
Create Domain
Link a domain that you own with MailSlurp so you can create email addresses using it.
|
okhttp3.Call |
DomainControllerApi.createDomainAsync(CreateDomainOptions domainOptions,
ApiCallback<DomainDto> _callback)
Create Domain (asynchronously)
Link a domain that you own with MailSlurp so you can create email addresses using it.
|
okhttp3.Call |
DomainControllerApi.createDomainCall(CreateDomainOptions domainOptions,
ApiCallback _callback)
Build call for createDomain
|
ApiResponse<DomainDto> |
DomainControllerApi.createDomainWithHttpInfo(CreateDomainOptions domainOptions)
Create Domain
Link a domain that you own with MailSlurp so you can create email addresses using it.
|
GroupDto |
GroupControllerApi.createGroup(CreateGroupOptions createGroupOptions)
Create a group
|
okhttp3.Call |
GroupControllerApi.createGroupAsync(CreateGroupOptions createGroupOptions,
ApiCallback<GroupDto> _callback)
Create a group (asynchronously)
|
okhttp3.Call |
GroupControllerApi.createGroupCall(CreateGroupOptions createGroupOptions,
ApiCallback _callback)
Build call for createGroup
|
ApiResponse<GroupDto> |
GroupControllerApi.createGroupWithHttpInfo(CreateGroupOptions createGroupOptions)
Create a group
|
Inbox |
InboxControllerApi.createInbox(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.
|
okhttp3.Call |
InboxControllerApi.createInboxAsync(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool,
ApiCallback<Inbox> _callback)
Create an Inbox (email address) (asynchronously)
Create a new inbox and with a randomized email address to send and receive from.
|
okhttp3.Call |
InboxControllerApi.createInboxCall(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool,
ApiCallback _callback)
Build call for createInbox
|
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.
|
Inbox |
InboxControllerApi.createInboxWithOptions(CreateInboxDto createInboxDto)
Create an inbox with additional options
Additional endpoint that allows inbox creation with request body options.
|
okhttp3.Call |
InboxControllerApi.createInboxWithOptionsAsync(CreateInboxDto createInboxDto,
ApiCallback<Inbox> _callback)
Create an inbox with additional options (asynchronously)
Additional endpoint that allows inbox creation with request body options.
|
okhttp3.Call |
InboxControllerApi.createInboxWithOptionsCall(CreateInboxDto createInboxDto,
ApiCallback _callback)
Build call for createInboxWithOptions
|
ApiResponse<Inbox> |
InboxControllerApi.createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto)
Create an inbox with additional options
Additional endpoint that allows inbox creation with request body options.
|
Inbox |
CommonActionsControllerApi.createNewEmailAddress(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
Inbox |
CommonActionsControllerApi.createNewEmailAddress1(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
|
okhttp3.Call |
CommonActionsControllerApi.createNewEmailAddress1Async(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool,
ApiCallback<Inbox> _callback)
Create new random inbox (asynchronously)
Returns an Inbox with an `id` and an `emailAddress`
|
okhttp3.Call |
CommonActionsControllerApi.createNewEmailAddress1Call(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool,
ApiCallback _callback)
Build call for createNewEmailAddress1
|
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`
|
okhttp3.Call |
CommonActionsControllerApi.createNewEmailAddressAsync(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool,
ApiCallback<Inbox> _callback)
Create new random inbox (asynchronously)
Returns an Inbox with an `id` and an `emailAddress`
|
okhttp3.Call |
CommonActionsControllerApi.createNewEmailAddressCall(Boolean allowTeamAccess,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean useDomainPool,
ApiCallback _callback)
Build call for createNewEmailAddress
|
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`
|
TemplateDto |
TemplateControllerApi.createTemplate(CreateTemplateOptions createTemplateOptions)
Create a Template
|
okhttp3.Call |
TemplateControllerApi.createTemplateAsync(CreateTemplateOptions createTemplateOptions,
ApiCallback<TemplateDto> _callback)
Create a Template (asynchronously)
|
okhttp3.Call |
TemplateControllerApi.createTemplateCall(CreateTemplateOptions createTemplateOptions,
ApiCallback _callback)
Build call for createTemplate
|
ApiResponse<TemplateDto> |
TemplateControllerApi.createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions)
Create a Template
|
WebhookDto |
WebhookControllerApi.createWebhook(UUID inboxId,
CreateWebhookOptions webhookOptions)
Attach a WebHook URL to an inbox
Get notified whenever an inbox receives an email via a WebHook URL.
|
okhttp3.Call |
WebhookControllerApi.createWebhookAsync(UUID inboxId,
CreateWebhookOptions webhookOptions,
ApiCallback<WebhookDto> _callback)
Attach a WebHook URL to an inbox (asynchronously)
Get notified whenever an inbox receives an email via a WebHook URL.
|
okhttp3.Call |
WebhookControllerApi.createWebhookCall(UUID inboxId,
CreateWebhookOptions webhookOptions,
ApiCallback _callback)
Build call for createWebhook
|
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.
|
void |
AliasControllerApi.deleteAlias(UUID aliasId)
Delete an email alias
|
okhttp3.Call |
AliasControllerApi.deleteAliasAsync(UUID aliasId,
ApiCallback<Void> _callback)
Delete an email alias (asynchronously)
|
okhttp3.Call |
AliasControllerApi.deleteAliasCall(UUID aliasId,
ApiCallback _callback)
Build call for deleteAlias
|
ApiResponse<Void> |
AliasControllerApi.deleteAliasWithHttpInfo(UUID aliasId)
Delete an email alias
|
void |
EmailControllerApi.deleteAllEmails()
Delete all emails
Deletes all emails in your account.
|
okhttp3.Call |
EmailControllerApi.deleteAllEmailsAsync(ApiCallback<Void> _callback)
Delete all emails (asynchronously)
Deletes all emails in your account.
|
okhttp3.Call |
EmailControllerApi.deleteAllEmailsCall(ApiCallback _callback)
Build call for deleteAllEmails
|
ApiResponse<Void> |
EmailControllerApi.deleteAllEmailsWithHttpInfo()
Delete all emails
Deletes all emails in your account.
|
void |
InboxControllerApi.deleteAllInboxes()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
InboxControllerApi.deleteAllInboxesAsync(ApiCallback<Void> _callback)
Delete all inboxes (asynchronously)
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
InboxControllerApi.deleteAllInboxesCall(ApiCallback _callback)
Build call for deleteAllInboxes
|
ApiResponse<Void> |
InboxControllerApi.deleteAllInboxesWithHttpInfo()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
void |
ContactControllerApi.deleteContact(UUID contactId)
Delete contact
|
okhttp3.Call |
ContactControllerApi.deleteContactAsync(UUID contactId,
ApiCallback<Void> _callback)
Delete contact (asynchronously)
|
okhttp3.Call |
ContactControllerApi.deleteContactCall(UUID contactId,
ApiCallback _callback)
Build call for deleteContact
|
ApiResponse<Void> |
ContactControllerApi.deleteContactWithHttpInfo(UUID contactId)
Delete contact
|
List<String> |
DomainControllerApi.deleteDomain(UUID id)
Delete a domain
Delete a domain.
|
okhttp3.Call |
DomainControllerApi.deleteDomainAsync(UUID id,
ApiCallback<List<String>> _callback)
Delete a domain (asynchronously)
Delete a domain.
|
okhttp3.Call |
DomainControllerApi.deleteDomainCall(UUID id,
ApiCallback _callback)
Build call for deleteDomain
|
ApiResponse<List<String>> |
DomainControllerApi.deleteDomainWithHttpInfo(UUID id)
Delete a domain
Delete a domain.
|
void |
EmailControllerApi.deleteEmail(UUID emailId)
Delete an email
Deletes an email and removes it from the inbox.
|
okhttp3.Call |
EmailControllerApi.deleteEmailAsync(UUID emailId,
ApiCallback<Void> _callback)
Delete an email (asynchronously)
Deletes an email and removes it from the inbox.
|
okhttp3.Call |
EmailControllerApi.deleteEmailCall(UUID emailId,
ApiCallback _callback)
Build call for deleteEmail
|
ApiResponse<Void> |
EmailControllerApi.deleteEmailWithHttpInfo(UUID emailId)
Delete an email
Deletes an email and removes it from the inbox.
|
void |
GroupControllerApi.deleteGroup(UUID groupId)
Delete group
|
okhttp3.Call |
GroupControllerApi.deleteGroupAsync(UUID groupId,
ApiCallback<Void> _callback)
Delete group (asynchronously)
|
okhttp3.Call |
GroupControllerApi.deleteGroupCall(UUID groupId,
ApiCallback _callback)
Build call for deleteGroup
|
ApiResponse<Void> |
GroupControllerApi.deleteGroupWithHttpInfo(UUID groupId)
Delete group
|
void |
InboxControllerApi.deleteInbox(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
okhttp3.Call |
InboxControllerApi.deleteInboxAsync(UUID inboxId,
ApiCallback<Void> _callback)
Delete inbox (asynchronously)
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
okhttp3.Call |
InboxControllerApi.deleteInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for deleteInbox
|
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.
|
void |
TemplateControllerApi.deleteTemplate(UUID templateId)
Delete Template
|
okhttp3.Call |
TemplateControllerApi.deleteTemplateAsync(UUID templateId,
ApiCallback<Void> _callback)
Delete Template (asynchronously)
|
okhttp3.Call |
TemplateControllerApi.deleteTemplateCall(UUID templateId,
ApiCallback _callback)
Build call for deleteTemplate
|
ApiResponse<Void> |
TemplateControllerApi.deleteTemplateWithHttpInfo(UUID templateId)
Delete Template
|
void |
WebhookControllerApi.deleteWebhook(UUID inboxId,
UUID webhookId)
Delete and disable a Webhook for an Inbox
|
okhttp3.Call |
WebhookControllerApi.deleteWebhookAsync(UUID inboxId,
UUID webhookId,
ApiCallback<Void> _callback)
Delete and disable a Webhook for an Inbox (asynchronously)
|
okhttp3.Call |
WebhookControllerApi.deleteWebhookCall(UUID inboxId,
UUID webhookId,
ApiCallback _callback)
Build call for deleteWebhook
|
ApiResponse<Void> |
WebhookControllerApi.deleteWebhookWithHttpInfo(UUID inboxId,
UUID webhookId)
Delete and disable a Webhook for an Inbox
|
DescribeMailServerDomainResult |
MailServerControllerApi.describeMailServerDomain(DescribeDomainOptions describeOptions)
Get DNS Mail Server records for a domain
|
okhttp3.Call |
MailServerControllerApi.describeMailServerDomainAsync(DescribeDomainOptions describeOptions,
ApiCallback<DescribeMailServerDomainResult> _callback)
Get DNS Mail Server records for a domain (asynchronously)
|
okhttp3.Call |
MailServerControllerApi.describeMailServerDomainCall(DescribeDomainOptions describeOptions,
ApiCallback _callback)
Build call for describeMailServerDomain
|
ApiResponse<DescribeMailServerDomainResult> |
MailServerControllerApi.describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeOptions)
Get DNS Mail Server records for a domain
|
byte[] |
EmailControllerApi.downloadAttachment(String attachmentId,
UUID emailId,
String apiKey)
Get email attachment bytes.
|
okhttp3.Call |
EmailControllerApi.downloadAttachmentAsync(String attachmentId,
UUID emailId,
String apiKey,
ApiCallback<byte[]> _callback)
Get email attachment bytes.
|
DownloadAttachmentDto |
EmailControllerApi.downloadAttachmentBase64(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.
|
okhttp3.Call |
EmailControllerApi.downloadAttachmentBase64Async(String attachmentId,
UUID emailId,
ApiCallback<DownloadAttachmentDto> _callback)
Get email attachment as base64 encoded string (alternative to binary responses) (asynchronously)
Returns the specified attachment for a given email as a base 64 encoded string.
|
okhttp3.Call |
EmailControllerApi.downloadAttachmentBase64Call(String attachmentId,
UUID emailId,
ApiCallback _callback)
Build call for downloadAttachmentBase64
|
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.
|
okhttp3.Call |
EmailControllerApi.downloadAttachmentCall(String attachmentId,
UUID emailId,
String apiKey,
ApiCallback _callback)
Build call for downloadAttachment
|
ApiResponse<byte[]> |
EmailControllerApi.downloadAttachmentWithHttpInfo(String attachmentId,
UUID emailId,
String apiKey)
Get email attachment bytes.
|
void |
CommonActionsControllerApi.emptyInbox(UUID inboxId)
Delete all emails in an inbox
Deletes all emails
|
okhttp3.Call |
CommonActionsControllerApi.emptyInboxAsync(UUID inboxId,
ApiCallback<Void> _callback)
Delete all emails in an inbox (asynchronously)
Deletes all emails
|
okhttp3.Call |
CommonActionsControllerApi.emptyInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for emptyInbox
|
ApiResponse<Void> |
CommonActionsControllerApi.emptyInboxWithHttpInfo(UUID inboxId)
Delete all emails in an inbox
Deletes all emails
|
void |
EmailControllerApi.forwardEmail(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email
Forward an existing email to new recipients.
|
okhttp3.Call |
EmailControllerApi.forwardEmailAsync(UUID emailId,
ForwardEmailOptions forwardEmailOptions,
ApiCallback<Void> _callback)
Forward email (asynchronously)
Forward an existing email to new recipients.
|
okhttp3.Call |
EmailControllerApi.forwardEmailCall(UUID emailId,
ForwardEmailOptions forwardEmailOptions,
ApiCallback _callback)
Build call for forwardEmail
|
ApiResponse<Void> |
EmailControllerApi.forwardEmailWithHttpInfo(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email
Forward an existing email to new recipients.
|
AliasDto |
AliasControllerApi.getAlias(UUID aliasId)
Get an email alias
Get an email alias by ID
|
okhttp3.Call |
AliasControllerApi.getAliasAsync(UUID aliasId,
ApiCallback<AliasDto> _callback)
Get an email alias (asynchronously)
Get an email alias by ID
|
okhttp3.Call |
AliasControllerApi.getAliasCall(UUID aliasId,
ApiCallback _callback)
Build call for getAlias
|
PageEmailProjection |
AliasControllerApi.getAliasEmails(UUID aliasId,
Integer page,
Integer size,
String sort)
Get emails for an alias
Get paginated emails for an alias by ID
|
okhttp3.Call |
AliasControllerApi.getAliasEmailsAsync(UUID aliasId,
Integer page,
Integer size,
String sort,
ApiCallback<PageEmailProjection> _callback)
Get emails for an alias (asynchronously)
Get paginated emails for an alias by ID
|
okhttp3.Call |
AliasControllerApi.getAliasEmailsCall(UUID aliasId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAliasEmails
|
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
|
PageAlias |
AliasControllerApi.getAliases(Integer page,
Integer size,
String sort)
Get all email aliases you have created
Get all email aliases in paginated form
|
okhttp3.Call |
AliasControllerApi.getAliasesAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageAlias> _callback)
Get all email aliases you have created (asynchronously)
Get all email aliases in paginated form
|
okhttp3.Call |
AliasControllerApi.getAliasesCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAliases
|
ApiResponse<PageAlias> |
AliasControllerApi.getAliasesWithHttpInfo(Integer page,
Integer size,
String sort)
Get all email aliases you have created
Get all email aliases in paginated form
|
PageThreadProjection |
AliasControllerApi.getAliasThreads(UUID aliasId,
Integer page,
Integer size,
String sort)
Get threads created for an alias
Returns threads created for an email alias in paginated form
|
okhttp3.Call |
AliasControllerApi.getAliasThreadsAsync(UUID aliasId,
Integer page,
Integer size,
String sort,
ApiCallback<PageThreadProjection> _callback)
Get threads created for an alias (asynchronously)
Returns threads created for an email alias in paginated form
|
okhttp3.Call |
AliasControllerApi.getAliasThreadsCall(UUID aliasId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAliasThreads
|
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
|
PageContactProjection |
ContactControllerApi.getAllContacts(Integer page,
Integer size,
String sort)
Get all contacts
|
okhttp3.Call |
ContactControllerApi.getAllContactsAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageContactProjection> _callback)
Get all contacts (asynchronously)
|
okhttp3.Call |
ContactControllerApi.getAllContactsCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAllContacts
|
ApiResponse<PageContactProjection> |
ContactControllerApi.getAllContactsWithHttpInfo(Integer page,
Integer size,
String sort)
Get all contacts
|
PageGroupProjection |
GroupControllerApi.getAllGroups(Integer page,
Integer size,
String sort)
Get all Contact Groups in paginated format
|
okhttp3.Call |
GroupControllerApi.getAllGroupsAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageGroupProjection> _callback)
Get all Contact Groups in paginated format (asynchronously)
|
okhttp3.Call |
GroupControllerApi.getAllGroupsCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAllGroups
|
ApiResponse<PageGroupProjection> |
GroupControllerApi.getAllGroupsWithHttpInfo(Integer page,
Integer size,
String sort)
Get all Contact Groups in paginated format
|
PageInboxProjection |
InboxControllerApi.getAllInboxes(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess)
List All Inboxes Paginated
List inboxes in paginated form.
|
okhttp3.Call |
InboxControllerApi.getAllInboxesAsync(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess,
ApiCallback<PageInboxProjection> _callback)
List All Inboxes Paginated (asynchronously)
List inboxes in paginated form.
|
okhttp3.Call |
InboxControllerApi.getAllInboxesCall(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess,
ApiCallback _callback)
Build call for getAllInboxes
|
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.
|
PageTemplateProjection |
TemplateControllerApi.getAllTemplates(Integer page,
Integer size,
String sort)
Get all Templates in paginated format
|
okhttp3.Call |
TemplateControllerApi.getAllTemplatesAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageTemplateProjection> _callback)
Get all Templates in paginated format (asynchronously)
|
okhttp3.Call |
TemplateControllerApi.getAllTemplatesCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAllTemplates
|
ApiResponse<PageTemplateProjection> |
TemplateControllerApi.getAllTemplatesWithHttpInfo(Integer page,
Integer size,
String sort)
Get all Templates in paginated format
|
PageWebhookProjection |
WebhookControllerApi.getAllWebhooks(Integer page,
Integer size,
String sort)
List Webhooks Paginated
List webhooks in paginated form.
|
okhttp3.Call |
WebhookControllerApi.getAllWebhooksAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageWebhookProjection> _callback)
List Webhooks Paginated (asynchronously)
List webhooks in paginated form.
|
okhttp3.Call |
WebhookControllerApi.getAllWebhooksCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getAllWebhooks
|
ApiResponse<PageWebhookProjection> |
WebhookControllerApi.getAllWebhooksWithHttpInfo(Integer page,
Integer size,
String sort)
List Webhooks Paginated
List webhooks in paginated form.
|
AttachmentMetaData |
EmailControllerApi.getAttachmentMetaData(String attachmentId,
UUID emailId)
Get email attachment metadata
Returns the metadata such as name and content-type for a given attachment and email.
|
okhttp3.Call |
EmailControllerApi.getAttachmentMetaDataAsync(String attachmentId,
UUID emailId,
ApiCallback<AttachmentMetaData> _callback)
Get email attachment metadata (asynchronously)
Returns the metadata such as name and content-type for a given attachment and email.
|
okhttp3.Call |
EmailControllerApi.getAttachmentMetaDataCall(String attachmentId,
UUID emailId,
ApiCallback _callback)
Build call for getAttachmentMetaData
|
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.
|
List<AttachmentMetaData> |
EmailControllerApi.getAttachments(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.
|
okhttp3.Call |
EmailControllerApi.getAttachmentsAsync(UUID emailId,
ApiCallback<List<AttachmentMetaData>> _callback)
Get all email attachment metadata (asynchronously)
Returns an array of attachment metadata such as name and content-type for a given email if present.
|
okhttp3.Call |
EmailControllerApi.getAttachmentsCall(UUID emailId,
ApiCallback _callback)
Build call for getAttachments
|
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.
|
ContactDto |
ContactControllerApi.getContact(UUID contactId)
Get contact
|
okhttp3.Call |
ContactControllerApi.getContactAsync(UUID contactId,
ApiCallback<ContactDto> _callback)
Get contact (asynchronously)
|
okhttp3.Call |
ContactControllerApi.getContactCall(UUID contactId,
ApiCallback _callback)
Build call for getContact
|
List<ContactProjection> |
ContactControllerApi.getContacts()
Get all contacts
|
okhttp3.Call |
ContactControllerApi.getContactsAsync(ApiCallback<List<ContactProjection>> _callback)
Get all contacts (asynchronously)
|
okhttp3.Call |
ContactControllerApi.getContactsCall(ApiCallback _callback)
Build call for getContacts
|
ApiResponse<List<ContactProjection>> |
ContactControllerApi.getContactsWithHttpInfo()
Get all contacts
|
ApiResponse<ContactDto> |
ContactControllerApi.getContactWithHttpInfo(UUID contactId)
Get contact
|
DNSLookupResults |
MailServerControllerApi.getDnsLookup(DNSLookupOptions dnsLookupOptions)
Lookup DNS records for a domain
|
okhttp3.Call |
MailServerControllerApi.getDnsLookupAsync(DNSLookupOptions dnsLookupOptions,
ApiCallback<DNSLookupResults> _callback)
Lookup DNS records for a domain (asynchronously)
|
okhttp3.Call |
MailServerControllerApi.getDnsLookupCall(DNSLookupOptions dnsLookupOptions,
ApiCallback _callback)
Build call for getDnsLookup
|
ApiResponse<DNSLookupResults> |
MailServerControllerApi.getDnsLookupWithHttpInfo(DNSLookupOptions dnsLookupOptions)
Lookup DNS records for a domain
|
DomainDto |
DomainControllerApi.getDomain(UUID id)
Get a domain
Returns domain verification status and tokens for a given domain
|
okhttp3.Call |
DomainControllerApi.getDomainAsync(UUID id,
ApiCallback<DomainDto> _callback)
Get a domain (asynchronously)
Returns domain verification status and tokens for a given domain
|
okhttp3.Call |
DomainControllerApi.getDomainCall(UUID id,
ApiCallback _callback)
Build call for getDomain
|
List<DomainPreview> |
DomainControllerApi.getDomains()
Get domains
List all custom domains you have created
|
okhttp3.Call |
DomainControllerApi.getDomainsAsync(ApiCallback<List<DomainPreview>> _callback)
Get domains (asynchronously)
List all custom domains you have created
|
okhttp3.Call |
DomainControllerApi.getDomainsCall(ApiCallback _callback)
Build call for getDomains
|
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
|
Email |
EmailControllerApi.getEmail(UUID emailId,
Boolean decode)
Get email content
Returns a email summary object with headers and content.
|
okhttp3.Call |
EmailControllerApi.getEmailAsync(UUID emailId,
Boolean decode,
ApiCallback<Email> _callback)
Get email content (asynchronously)
Returns a email summary object with headers and content.
|
okhttp3.Call |
EmailControllerApi.getEmailCall(UUID emailId,
Boolean decode,
ApiCallback _callback)
Build call for getEmail
|
EmailContentMatchResult |
EmailControllerApi.getEmailContentMatch(UUID emailId,
ContentMatchOptions contentMatchOptions)
Get email content regex pattern match results.
|
okhttp3.Call |
EmailControllerApi.getEmailContentMatchAsync(UUID emailId,
ContentMatchOptions contentMatchOptions,
ApiCallback<EmailContentMatchResult> _callback)
Get email content regex pattern match results.
|
okhttp3.Call |
EmailControllerApi.getEmailContentMatchCall(UUID emailId,
ContentMatchOptions contentMatchOptions,
ApiCallback _callback)
Build call for getEmailContentMatch
|
ApiResponse<EmailContentMatchResult> |
EmailControllerApi.getEmailContentMatchWithHttpInfo(UUID emailId,
ContentMatchOptions contentMatchOptions)
Get email content regex pattern match results.
|
String |
EmailControllerApi.getEmailHTML(UUID emailId,
Boolean decode)
Get email content as HTML
Retrieve email content as HTML response for viewing in browsers.
|
okhttp3.Call |
EmailControllerApi.getEmailHTMLAsync(UUID emailId,
Boolean decode,
ApiCallback<String> _callback)
Get email content as HTML (asynchronously)
Retrieve email content as HTML response for viewing in browsers.
|
okhttp3.Call |
EmailControllerApi.getEmailHTMLCall(UUID emailId,
Boolean decode,
ApiCallback _callback)
Build call for getEmailHTML
|
EmailTextLinesResult |
EmailControllerApi.getEmailHTMLQuery(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.
|
okhttp3.Call |
EmailControllerApi.getEmailHTMLQueryAsync(UUID emailId,
String htmlSelector,
ApiCallback<EmailTextLinesResult> _callback)
Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously)
Parse an email body and return the content as an array of text.
|
okhttp3.Call |
EmailControllerApi.getEmailHTMLQueryCall(UUID emailId,
String htmlSelector,
ApiCallback _callback)
Build call for getEmailHTMLQuery
|
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.
|
List<EmailPreview> |
InboxControllerApi.getEmails(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort)
Get emails in an Inbox.
|
okhttp3.Call |
InboxControllerApi.getEmailsAsync(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort,
ApiCallback<List<EmailPreview>> _callback)
Get emails in an Inbox.
|
okhttp3.Call |
InboxControllerApi.getEmailsCall(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort,
ApiCallback _callback)
Build call for getEmails
|
PageEmailProjection |
EmailControllerApi.getEmailsPaginated(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.
|
okhttp3.Call |
EmailControllerApi.getEmailsPaginatedAsync(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
ApiCallback<PageEmailProjection> _callback)
Get all emails (asynchronously)
By default returns all emails across all inboxes sorted by ascending created at date.
|
okhttp3.Call |
EmailControllerApi.getEmailsPaginatedCall(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
ApiCallback _callback)
Build call for getEmailsPaginated
|
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.
|
EmailTextLinesResult |
EmailControllerApi.getEmailTextLines(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.
|
okhttp3.Call |
EmailControllerApi.getEmailTextLinesAsync(UUID emailId,
Boolean decodeHtmlEntities,
String lineSeparator,
ApiCallback<EmailTextLinesResult> _callback)
Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously)
Parse an email body and return the content as an array of strings.
|
okhttp3.Call |
EmailControllerApi.getEmailTextLinesCall(UUID emailId,
Boolean decodeHtmlEntities,
String lineSeparator,
ApiCallback _callback)
Build call for getEmailTextLines
|
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.
|
ExpirationDefaults |
ExpiredControllerApi.getExpirationDefaults()
Get default expiration settings
Return default times used for inbox expiration
|
okhttp3.Call |
ExpiredControllerApi.getExpirationDefaultsAsync(ApiCallback<ExpirationDefaults> _callback)
Get default expiration settings (asynchronously)
Return default times used for inbox expiration
|
okhttp3.Call |
ExpiredControllerApi.getExpirationDefaultsCall(ApiCallback _callback)
Build call for getExpirationDefaults
|
ApiResponse<ExpirationDefaults> |
ExpiredControllerApi.getExpirationDefaultsWithHttpInfo()
Get default expiration settings
Return default times used for inbox expiration
|
ExpiredInboxDto |
ExpiredControllerApi.getExpiredInboxByInboxId(UUID inboxId)
Get expired inbox record for a previously existing inbox
Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxByInboxIdAsync(UUID inboxId,
ApiCallback<ExpiredInboxDto> _callback)
Get expired inbox record for a previously existing inbox (asynchronously)
Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxByInboxIdCall(UUID inboxId,
ApiCallback _callback)
Build call for getExpiredInboxByInboxId
|
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.
|
PageExpiredInboxRecordProjection |
ExpiredControllerApi.getExpiredInboxes(Integer page,
Integer size,
String sort)
List records of expired inboxes
Inboxes created with an expiration date will expire after the given date.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxesAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageExpiredInboxRecordProjection> _callback)
List records of expired inboxes (asynchronously)
Inboxes created with an expiration date will expire after the given date.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxesCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getExpiredInboxes
|
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.
|
ExpiredInboxDto |
ExpiredControllerApi.getExpiredInboxRecord(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.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxRecordAsync(UUID expiredId,
ApiCallback<ExpiredInboxDto> _callback)
Get an expired inbox record (asynchronously)
Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
|
okhttp3.Call |
ExpiredControllerApi.getExpiredInboxRecordCall(UUID expiredId,
ApiCallback _callback)
Build call for getExpiredInboxRecord
|
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.
|
GroupDto |
GroupControllerApi.getGroup(UUID groupId)
Get group
|
okhttp3.Call |
GroupControllerApi.getGroupAsync(UUID groupId,
ApiCallback<GroupDto> _callback)
Get group (asynchronously)
|
okhttp3.Call |
GroupControllerApi.getGroupCall(UUID groupId,
ApiCallback _callback)
Build call for getGroup
|
List<GroupProjection> |
GroupControllerApi.getGroups()
Get all groups
|
okhttp3.Call |
GroupControllerApi.getGroupsAsync(ApiCallback<List<GroupProjection>> _callback)
Get all groups (asynchronously)
|
okhttp3.Call |
GroupControllerApi.getGroupsCall(ApiCallback _callback)
Build call for getGroups
|
ApiResponse<List<GroupProjection>> |
GroupControllerApi.getGroupsWithHttpInfo()
Get all groups
|
GroupContactsDto |
GroupControllerApi.getGroupWithContacts(UUID groupId)
Get group and contacts belonging to it
|
okhttp3.Call |
GroupControllerApi.getGroupWithContactsAsync(UUID groupId,
ApiCallback<GroupContactsDto> _callback)
Get group and contacts belonging to it (asynchronously)
|
okhttp3.Call |
GroupControllerApi.getGroupWithContactsCall(UUID groupId,
ApiCallback _callback)
Build call for getGroupWithContacts
|
PageContactProjection |
GroupControllerApi.getGroupWithContactsPaginated(UUID groupId,
Integer page,
Integer size,
String sort)
Get group and paginated contacts belonging to it
|
okhttp3.Call |
GroupControllerApi.getGroupWithContactsPaginatedAsync(UUID groupId,
Integer page,
Integer size,
String sort,
ApiCallback<PageContactProjection> _callback)
Get group and paginated contacts belonging to it (asynchronously)
|
okhttp3.Call |
GroupControllerApi.getGroupWithContactsPaginatedCall(UUID groupId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getGroupWithContactsPaginated
|
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
|
Inbox |
InboxControllerApi.getInbox(UUID inboxId)
Get Inbox
Returns an inbox's properties, including its email address and ID.
|
okhttp3.Call |
InboxControllerApi.getInboxAsync(UUID inboxId,
ApiCallback<Inbox> _callback)
Get Inbox (asynchronously)
Returns an inbox's properties, including its email address and ID.
|
okhttp3.Call |
InboxControllerApi.getInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for getInbox
|
PageEmailPreview |
InboxControllerApi.getInboxEmailsPaginated(UUID inboxId,
Integer page,
Integer size,
String sort)
Get inbox emails paginated
Get a paginated list of emails in an inbox.
|
okhttp3.Call |
InboxControllerApi.getInboxEmailsPaginatedAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageEmailPreview> _callback)
Get inbox emails paginated (asynchronously)
Get a paginated list of emails in an inbox.
|
okhttp3.Call |
InboxControllerApi.getInboxEmailsPaginatedCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxEmailsPaginated
|
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.
|
List<Inbox> |
InboxControllerApi.getInboxes(Integer size,
String sort)
List Inboxes / Email Addresses
List the inboxes you have created.
|
okhttp3.Call |
InboxControllerApi.getInboxesAsync(Integer size,
String sort,
ApiCallback<List<Inbox>> _callback)
List Inboxes / Email Addresses (asynchronously)
List the inboxes you have created.
|
okhttp3.Call |
InboxControllerApi.getInboxesCall(Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxes
|
ApiResponse<List<Inbox>> |
InboxControllerApi.getInboxesWithHttpInfo(Integer size,
String sort)
List Inboxes / Email Addresses
List the inboxes you have created.
|
PageSentEmailProjection |
InboxControllerApi.getInboxSentEmails(UUID inboxId,
Integer page,
Integer size,
String sort)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
okhttp3.Call |
InboxControllerApi.getInboxSentEmailsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageSentEmailProjection> _callback)
Get Inbox Sent Emails (asynchronously)
Returns an inbox's sent email receipts.
|
okhttp3.Call |
InboxControllerApi.getInboxSentEmailsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxSentEmails
|
ApiResponse<PageSentEmailProjection> |
InboxControllerApi.getInboxSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
List<String> |
InboxControllerApi.getInboxTags()
Get inbox tags
Get all inbox tags
|
okhttp3.Call |
InboxControllerApi.getInboxTagsAsync(ApiCallback<List<String>> _callback)
Get inbox tags (asynchronously)
Get all inbox tags
|
okhttp3.Call |
InboxControllerApi.getInboxTagsCall(ApiCallback _callback)
Build call for getInboxTags
|
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.
|
IPAddressResult |
MailServerControllerApi.getIpAddress(String name)
Get IP address for a domain
|
okhttp3.Call |
MailServerControllerApi.getIpAddressAsync(String name,
ApiCallback<IPAddressResult> _callback)
Get IP address for a domain (asynchronously)
|
okhttp3.Call |
MailServerControllerApi.getIpAddressCall(String name,
ApiCallback _callback)
Build call for getIpAddress
|
ApiResponse<IPAddressResult> |
MailServerControllerApi.getIpAddressWithHttpInfo(String name)
Get IP address for a domain
|
Email |
EmailControllerApi.getLatestEmail(List<UUID> inboxIds)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
|
okhttp3.Call |
EmailControllerApi.getLatestEmailAsync(List<UUID> inboxIds,
ApiCallback<Email> _callback)
Get latest email (asynchronously)
Get the newest email in all inboxes or in a passed set of inbox IDs
|
okhttp3.Call |
EmailControllerApi.getLatestEmailCall(List<UUID> inboxIds,
ApiCallback _callback)
Build call for getLatestEmail
|
Email |
EmailControllerApi.getLatestEmailInInbox(UUID inboxId)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
|
okhttp3.Call |
EmailControllerApi.getLatestEmailInInboxAsync(UUID inboxId,
ApiCallback<Email> _callback)
Get latest email (asynchronously)
Get the newest email in all inboxes or in a passed set of inbox IDs
|
okhttp3.Call |
EmailControllerApi.getLatestEmailInInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for getLatestEmailInInbox
|
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
|
PageEmailProjection |
EmailControllerApi.getOrganizationEmailsPaginated(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.
|
okhttp3.Call |
EmailControllerApi.getOrganizationEmailsPaginatedAsync(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
ApiCallback<PageEmailProjection> _callback)
Get all organization emails (asynchronously)
By default returns all emails across all team inboxes sorted by ascending created at date.
|
okhttp3.Call |
EmailControllerApi.getOrganizationEmailsPaginatedCall(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
ApiCallback _callback)
Build call for getOrganizationEmailsPaginated
|
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.
|
PageOrganizationInboxProjection |
InboxControllerApi.getOrganizationInboxes(Integer page,
Integer size,
String sort)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
okhttp3.Call |
InboxControllerApi.getOrganizationInboxesAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageOrganizationInboxProjection> _callback)
List Organization Inboxes Paginated (asynchronously)
List organization inboxes in paginated form.
|
okhttp3.Call |
InboxControllerApi.getOrganizationInboxesCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getOrganizationInboxes
|
ApiResponse<PageOrganizationInboxProjection> |
InboxControllerApi.getOrganizationInboxesWithHttpInfo(Integer page,
Integer size,
String sort)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
String |
EmailControllerApi.getRawEmailContents(UUID emailId)
Get raw email string
Returns a raw, unparsed, and unprocessed email.
|
okhttp3.Call |
EmailControllerApi.getRawEmailContentsAsync(UUID emailId,
ApiCallback<String> _callback)
Get raw email string (asynchronously)
Returns a raw, unparsed, and unprocessed email.
|
okhttp3.Call |
EmailControllerApi.getRawEmailContentsCall(UUID emailId,
ApiCallback _callback)
Build call for getRawEmailContents
|
ApiResponse<String> |
EmailControllerApi.getRawEmailContentsWithHttpInfo(UUID emailId)
Get raw email string
Returns a raw, unparsed, and unprocessed email.
|
RawEmailJson |
EmailControllerApi.getRawEmailJson(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
|
okhttp3.Call |
EmailControllerApi.getRawEmailJsonAsync(UUID emailId,
ApiCallback<RawEmailJson> _callback)
Get raw email in JSON (asynchronously)
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
|
okhttp3.Call |
EmailControllerApi.getRawEmailJsonCall(UUID emailId,
ApiCallback _callback)
Build call for getRawEmailJson
|
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
|
SentEmailDto |
SentEmailsControllerApi.getSentEmail(UUID id)
Get sent email receipt
|
okhttp3.Call |
SentEmailsControllerApi.getSentEmailAsync(UUID id,
ApiCallback<SentEmailDto> _callback)
Get sent email receipt (asynchronously)
|
okhttp3.Call |
SentEmailsControllerApi.getSentEmailCall(UUID id,
ApiCallback _callback)
Build call for getSentEmail
|
PageSentEmailProjection |
SentEmailsControllerApi.getSentEmails(UUID inboxId,
Integer page,
Integer size,
String sort)
Get all sent emails in paginated form
|
okhttp3.Call |
SentEmailsControllerApi.getSentEmailsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageSentEmailProjection> _callback)
Get all sent emails in paginated form (asynchronously)
|
okhttp3.Call |
SentEmailsControllerApi.getSentEmailsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getSentEmails
|
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
|
PageSentEmailProjection |
SentEmailsControllerApi.getSentOrganizationEmails(UUID inboxId,
Integer page,
Integer size,
String sort)
Get all sent organization emails in paginated form
|
okhttp3.Call |
SentEmailsControllerApi.getSentOrganizationEmailsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageSentEmailProjection> _callback)
Get all sent organization emails in paginated form (asynchronously)
|
okhttp3.Call |
SentEmailsControllerApi.getSentOrganizationEmailsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getSentOrganizationEmails
|
ApiResponse<PageSentEmailProjection> |
SentEmailsControllerApi.getSentOrganizationEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get all sent organization emails in paginated form
|
TemplateDto |
TemplateControllerApi.getTemplate(UUID templateId)
Get Template
|
okhttp3.Call |
TemplateControllerApi.getTemplateAsync(UUID templateId,
ApiCallback<TemplateDto> _callback)
Get Template (asynchronously)
|
okhttp3.Call |
TemplateControllerApi.getTemplateCall(UUID templateId,
ApiCallback _callback)
Build call for getTemplate
|
List<TemplateProjection> |
TemplateControllerApi.getTemplates()
Get all Templates
|
okhttp3.Call |
TemplateControllerApi.getTemplatesAsync(ApiCallback<List<TemplateProjection>> _callback)
Get all Templates (asynchronously)
|
okhttp3.Call |
TemplateControllerApi.getTemplatesCall(ApiCallback _callback)
Build call for getTemplates
|
ApiResponse<List<TemplateProjection>> |
TemplateControllerApi.getTemplatesWithHttpInfo()
Get all Templates
|
ApiResponse<TemplateDto> |
TemplateControllerApi.getTemplateWithHttpInfo(UUID templateId)
Get Template
|
UnreadCount |
EmailControllerApi.getUnreadEmailCount()
Get unread email count
Get number of emails unread
|
okhttp3.Call |
EmailControllerApi.getUnreadEmailCountAsync(ApiCallback<UnreadCount> _callback)
Get unread email count (asynchronously)
Get number of emails unread
|
okhttp3.Call |
EmailControllerApi.getUnreadEmailCountCall(ApiCallback _callback)
Build call for getUnreadEmailCount
|
ApiResponse<UnreadCount> |
EmailControllerApi.getUnreadEmailCountWithHttpInfo()
Get unread email count
Get number of emails unread
|
WebhookDto |
WebhookControllerApi.getWebhook(UUID webhookId)
Get a webhook for an Inbox
|
okhttp3.Call |
WebhookControllerApi.getWebhookAsync(UUID webhookId,
ApiCallback<WebhookDto> _callback)
Get a webhook for an Inbox (asynchronously)
|
okhttp3.Call |
WebhookControllerApi.getWebhookCall(UUID webhookId,
ApiCallback _callback)
Build call for getWebhook
|
List<WebhookDto> |
WebhookControllerApi.getWebhooks(UUID inboxId)
Get all Webhooks for an Inbox
|
okhttp3.Call |
WebhookControllerApi.getWebhooksAsync(UUID inboxId,
ApiCallback<List<WebhookDto>> _callback)
Get all Webhooks for an Inbox (asynchronously)
|
okhttp3.Call |
WebhookControllerApi.getWebhooksCall(UUID inboxId,
ApiCallback _callback)
Build call for getWebhooks
|
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
|
GroupContactsDto |
GroupControllerApi.removeContactsFromGroup(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Remove contacts from a group
|
okhttp3.Call |
GroupControllerApi.removeContactsFromGroupAsync(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback<GroupContactsDto> _callback)
Remove contacts from a group (asynchronously)
|
okhttp3.Call |
GroupControllerApi.removeContactsFromGroupCall(UUID groupId,
UpdateGroupContacts updateGroupContactsOption,
ApiCallback _callback)
Build call for removeContactsFromGroup
|
ApiResponse<GroupContactsDto> |
GroupControllerApi.removeContactsFromGroupWithHttpInfo(UUID groupId,
UpdateGroupContacts updateGroupContactsOption)
Remove contacts from a group
|
SentEmailDto |
AliasControllerApi.replyToAliasEmail(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.
|
okhttp3.Call |
AliasControllerApi.replyToAliasEmailAsync(UUID aliasId,
UUID emailId,
ReplyToAliasEmailOptions replyToAliasEmailOptions,
ApiCallback<SentEmailDto> _callback)
Reply to an email (asynchronously)
Send the reply to the email sender or reply-to and include same subject cc bcc etc.
|
okhttp3.Call |
AliasControllerApi.replyToAliasEmailCall(UUID aliasId,
UUID emailId,
ReplyToAliasEmailOptions replyToAliasEmailOptions,
ApiCallback _callback)
Build call for replyToAliasEmail
|
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.
|
SentEmailDto |
EmailControllerApi.replyToEmail(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.
|
okhttp3.Call |
EmailControllerApi.replyToEmailAsync(UUID emailId,
ReplyToEmailOptions replyToEmailOptions,
ApiCallback<SentEmailDto> _callback)
Reply to an email (asynchronously)
Send the reply to the email sender or reply-to and include same subject cc bcc etc.
|
okhttp3.Call |
EmailControllerApi.replyToEmailCall(UUID emailId,
ReplyToEmailOptions replyToEmailOptions,
ApiCallback _callback)
Build call for replyToEmail
|
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.
|
SentEmailDto |
AliasControllerApi.sendAliasEmail(UUID aliasId,
SendEmailOptions sendEmailOptions)
Send an email from an alias inbox
Send an email from an alias.
|
okhttp3.Call |
AliasControllerApi.sendAliasEmailAsync(UUID aliasId,
SendEmailOptions sendEmailOptions,
ApiCallback<SentEmailDto> _callback)
Send an email from an alias inbox (asynchronously)
Send an email from an alias.
|
okhttp3.Call |
AliasControllerApi.sendAliasEmailCall(UUID aliasId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendAliasEmail
|
ApiResponse<SentEmailDto> |
AliasControllerApi.sendAliasEmailWithHttpInfo(UUID aliasId,
SendEmailOptions sendEmailOptions)
Send an email from an alias inbox
Send an email from an alias.
|
void |
InboxControllerApi.sendEmail(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
SentEmailDto |
InboxControllerApi.sendEmailAndConfirm(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.
|
okhttp3.Call |
InboxControllerApi.sendEmailAndConfirmAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback<SentEmailDto> _callback)
Send email and return sent confirmation (asynchronously)
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.
|
okhttp3.Call |
InboxControllerApi.sendEmailAndConfirmCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmailAndConfirm
|
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.
|
okhttp3.Call |
InboxControllerApi.sendEmailAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback<Void> _callback)
Send Email (asynchronously)
Send an email from an inbox's email address.
|
okhttp3.Call |
InboxControllerApi.sendEmailCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmail
|
void |
CommonActionsControllerApi.sendEmailSimple(SimpleSendEmailOptions emailOptions)
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
|
okhttp3.Call |
CommonActionsControllerApi.sendEmailSimpleAsync(SimpleSendEmailOptions emailOptions,
ApiCallback<Void> _callback)
Send an email (asynchronously)
If no senderId or inboxId provided a random email address will be used to send from.
|
okhttp3.Call |
CommonActionsControllerApi.sendEmailSimpleCall(SimpleSendEmailOptions emailOptions,
ApiCallback _callback)
Build call for sendEmailSimple
|
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.
|
WebhookTestResult |
WebhookControllerApi.sendTestData(UUID webhookId)
Send webhook test data
|
okhttp3.Call |
WebhookControllerApi.sendTestDataAsync(UUID webhookId,
ApiCallback<WebhookTestResult> _callback)
Send webhook test data (asynchronously)
|
okhttp3.Call |
WebhookControllerApi.sendTestDataCall(UUID webhookId,
ApiCallback _callback)
Build call for sendTestData
|
ApiResponse<WebhookTestResult> |
WebhookControllerApi.sendTestDataWithHttpInfo(UUID webhookId)
Send webhook test data
|
Inbox |
InboxControllerApi.setInboxFavourited(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
okhttp3.Call |
InboxControllerApi.setInboxFavouritedAsync(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback<Inbox> _callback)
Set inbox favourited state (asynchronously)
Set and return new favourite state for an inbox
|
okhttp3.Call |
InboxControllerApi.setInboxFavouritedCall(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback _callback)
Build call for setInboxFavourited
|
ApiResponse<Inbox> |
InboxControllerApi.setInboxFavouritedWithHttpInfo(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
String |
FormControllerApi.submitForm(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.
|
okhttp3.Call |
FormControllerApi.submitFormAsync(String emailAddress,
String redirectTo,
String spamCheck,
String subject,
String successMessage,
String to,
String otherParameters,
ApiCallback<String> _callback)
Submit a form to be parsed and sent as an email to an address determined by the form fields (asynchronously)
This endpoint allows you to submit HTML forms and receive the field values and files via email.
|
okhttp3.Call |
FormControllerApi.submitFormCall(String emailAddress,
String redirectTo,
String spamCheck,
String subject,
String successMessage,
String to,
String otherParameters,
ApiCallback _callback)
Build call for submitForm
|
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.
|
void |
AliasControllerApi.updateAlias(UUID aliasId,
UpdateAliasOptions updateAliasOptions)
Update an email alias
|
okhttp3.Call |
AliasControllerApi.updateAliasAsync(UUID aliasId,
UpdateAliasOptions updateAliasOptions,
ApiCallback<Void> _callback)
Update an email alias (asynchronously)
|
okhttp3.Call |
AliasControllerApi.updateAliasCall(UUID aliasId,
UpdateAliasOptions updateAliasOptions,
ApiCallback _callback)
Build call for updateAlias
|
ApiResponse<Void> |
AliasControllerApi.updateAliasWithHttpInfo(UUID aliasId,
UpdateAliasOptions updateAliasOptions)
Update an email alias
|
DomainDto |
DomainControllerApi.updateDomain(UUID id,
UpdateDomainOptions updateDomainDto)
Update a domain
Update values on a domain.
|
okhttp3.Call |
DomainControllerApi.updateDomainAsync(UUID id,
UpdateDomainOptions updateDomainDto,
ApiCallback<DomainDto> _callback)
Update a domain (asynchronously)
Update values on a domain.
|
okhttp3.Call |
DomainControllerApi.updateDomainCall(UUID id,
UpdateDomainOptions updateDomainDto,
ApiCallback _callback)
Build call for updateDomain
|
ApiResponse<DomainDto> |
DomainControllerApi.updateDomainWithHttpInfo(UUID id,
UpdateDomainOptions updateDomainDto)
Update a domain
Update values on a domain.
|
Inbox |
InboxControllerApi.updateInbox(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox
Update editable fields on an inbox
|
okhttp3.Call |
InboxControllerApi.updateInboxAsync(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback<Inbox> _callback)
Update Inbox (asynchronously)
Update editable fields on an inbox
|
okhttp3.Call |
InboxControllerApi.updateInboxCall(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback _callback)
Build call for updateInbox
|
ApiResponse<Inbox> |
InboxControllerApi.updateInboxWithHttpInfo(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox
Update editable fields on an inbox
|
List<String> |
AttachmentControllerApi.uploadAttachment(UploadAttachmentOptions uploadOptions)
Upload an attachment for sending using base64 file encoding.
|
okhttp3.Call |
AttachmentControllerApi.uploadAttachmentAsync(UploadAttachmentOptions uploadOptions,
ApiCallback<List<String>> _callback)
Upload an attachment for sending using base64 file encoding.
|
List<String> |
AttachmentControllerApi.uploadAttachmentBytes(String string,
String filename,
byte[] byteArray)
Upload an attachment for sending using file byte stream input octet stream.
|
okhttp3.Call |
AttachmentControllerApi.uploadAttachmentBytesAsync(String string,
String filename,
byte[] byteArray,
ApiCallback<List<String>> _callback)
Upload an attachment for sending using file byte stream input octet stream.
|
okhttp3.Call |
AttachmentControllerApi.uploadAttachmentBytesCall(String string,
String filename,
byte[] byteArray,
ApiCallback _callback)
Build call for uploadAttachmentBytes
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentBytesWithHttpInfo(String string,
String filename,
byte[] byteArray)
Upload an attachment for sending using file byte stream input octet stream.
|
okhttp3.Call |
AttachmentControllerApi.uploadAttachmentCall(UploadAttachmentOptions uploadOptions,
ApiCallback _callback)
Build call for uploadAttachment
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadOptions)
Upload an attachment for sending using base64 file encoding.
|
List<String> |
AttachmentControllerApi.uploadMultipartForm(File file,
String contentType,
String filename,
String xFilename)
Upload an attachment for sending using a Multipart Form request.
|
okhttp3.Call |
AttachmentControllerApi.uploadMultipartFormAsync(File file,
String contentType,
String filename,
String xFilename,
ApiCallback<List<String>> _callback)
Upload an attachment for sending using a Multipart Form request.
|
okhttp3.Call |
AttachmentControllerApi.uploadMultipartFormCall(File file,
String contentType,
String filename,
String xFilename,
ApiCallback _callback)
Build call for uploadMultipartForm
|
ApiResponse<List<String>> |
AttachmentControllerApi.uploadMultipartFormWithHttpInfo(File file,
String contentType,
String filename,
String xFilename)
Upload an attachment for sending using a Multipart Form request.
|
ValidationDto |
EmailControllerApi.validateEmail(UUID emailId)
Validate email
Validate the HTML content of email if HTML is found.
|
okhttp3.Call |
EmailControllerApi.validateEmailAsync(UUID emailId,
ApiCallback<ValidationDto> _callback)
Validate email (asynchronously)
Validate the HTML content of email if HTML is found.
|
okhttp3.Call |
EmailControllerApi.validateEmailCall(UUID emailId,
ApiCallback _callback)
Build call for validateEmail
|
ApiResponse<ValidationDto> |
EmailControllerApi.validateEmailWithHttpInfo(UUID emailId)
Validate email
Validate the HTML content of email if HTML is found.
|
EmailVerificationResult |
MailServerControllerApi.verifyEmailAddress(VerifyEmailAddressOptions verifyOptions)
Verify the existence of an email address at a given mail server.
|
okhttp3.Call |
MailServerControllerApi.verifyEmailAddressAsync(VerifyEmailAddressOptions verifyOptions,
ApiCallback<EmailVerificationResult> _callback)
Verify the existence of an email address at a given mail server.
|
okhttp3.Call |
MailServerControllerApi.verifyEmailAddressCall(VerifyEmailAddressOptions verifyOptions,
ApiCallback _callback)
Build call for verifyEmailAddress
|
ApiResponse<EmailVerificationResult> |
MailServerControllerApi.verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyOptions)
Verify the existence of an email address at a given mail server.
|
List<EmailPreview> |
WaitForControllerApi.waitFor(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
|
okhttp3.Call |
WaitForControllerApi.waitForAsync(WaitForConditions waitForConditions,
ApiCallback<List<EmailPreview>> _callback)
Wait for conditions to be met (asynchronously)
Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
okhttp3.Call |
WaitForControllerApi.waitForCall(WaitForConditions waitForConditions,
ApiCallback _callback)
Build call for waitFor
|
List<EmailPreview> |
WaitForControllerApi.waitForEmailCount(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.
|
okhttp3.Call |
WaitForControllerApi.waitForEmailCountAsync(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<List<EmailPreview>> _callback)
Wait for and return count number of emails (asynchronously)
If inbox contains count or more emails at time of request then return count worth of emails.
|
okhttp3.Call |
WaitForControllerApi.waitForEmailCountCall(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForEmailCount
|
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.
|
Email |
WaitForControllerApi.waitForLatestEmail(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.
|
okhttp3.Call |
WaitForControllerApi.waitForLatestEmailAsync(UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Fetch inbox's latest email or if empty wait for an email to arrive (asynchronously)
Will return either the last received email or wait for an email to arrive and return that.
|
okhttp3.Call |
WaitForControllerApi.waitForLatestEmailCall(UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForLatestEmail
|
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.
|
List<EmailPreview> |
WaitForControllerApi.waitForMatchingEmail(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.
|
okhttp3.Call |
WaitForControllerApi.waitForMatchingEmailAsync(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<List<EmailPreview>> _callback)
Wait or return list of emails that match simple matching patterns (asynchronously)
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
WaitForControllerApi.waitForMatchingEmailCall(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForMatchingEmail
|
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.
|
Email |
WaitForControllerApi.waitForMatchingFirstEmail(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.
|
okhttp3.Call |
WaitForControllerApi.waitForMatchingFirstEmailAsync(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Wait for or return the first email that matches proved MatchOptions array (asynchronously)
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
WaitForControllerApi.waitForMatchingFirstEmailCall(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForMatchingFirstEmail
|
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.
|
Email |
WaitForControllerApi.waitForNthEmail(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.
|
okhttp3.Call |
WaitForControllerApi.waitForNthEmailAsync(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Wait for or fetch the email with a given index in the inbox specified (asynchronously)
If nth email is already present in inbox then return it.
|
okhttp3.Call |
WaitForControllerApi.waitForNthEmailCall(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForNthEmail
|
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 |
|---|---|
void |
ApiCallback.onFailure(ApiException e,
int statusCode,
Map<String,List<String>> responseHeaders)
This is called when the API call fails.
|
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Call |
ApiClient.buildCall(String path,
String method,
List<Pair> queryParams,
List<Pair> collectionQueryParams,
Object body,
Map<String,String> headerParams,
Map<String,String> cookieParams,
Map<String,Object> formParams,
String[] authNames,
ApiCallback callback)
Build HTTP call with the given options.
|
okhttp3.Request |
ApiClient.buildRequest(String path,
String method,
List<Pair> queryParams,
List<Pair> collectionQueryParams,
Object body,
Map<String,String> headerParams,
Map<String,String> cookieParams,
Map<String,Object> formParams,
String[] authNames,
ApiCallback callback)
Build an HTTP request with the given options.
|
<T> T |
ApiClient.deserialize(okhttp3.Response response,
Type returnType)
Deserialize response body to Java object, according to the return type and
the Content-Type response header.
|
File |
ApiClient.downloadFileFromResponse(okhttp3.Response response)
Download file from the given response.
|
<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.
|
<T> T |
ApiClient.handleResponse(okhttp3.Response response,
Type returnType)
Handle the given response, return the deserialized object when the response is successful.
|
okhttp3.RequestBody |
ApiClient.serialize(Object obj,
String contentType)
Serialize the given Java object into request body according to the object's
class and the request Content-Type.
|
Copyright © 2021. All rights reserved.