public class InboxControllerApi extends Object
| Constructor and Description |
|---|
InboxControllerApi() |
InboxControllerApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ScheduledJobDto |
cancelScheduledJob(UUID jobId)
Cancel a scheduled email job
Get a scheduled email job and cancel it.
|
okhttp3.Call |
cancelScheduledJobAsync(UUID jobId,
ApiCallback<ScheduledJobDto> _callback)
Cancel a scheduled email job (asynchronously)
Get a scheduled email job and cancel it.
|
okhttp3.Call |
cancelScheduledJobCall(UUID jobId,
ApiCallback _callback)
Build call for cancelScheduledJob
|
ApiResponse<ScheduledJobDto> |
cancelScheduledJobWithHttpInfo(UUID jobId)
Cancel a scheduled email job
Get a scheduled email job and cancel it.
|
InboxDto |
createInbox(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.
|
okhttp3.Call |
createInboxAsync(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,
ApiCallback<InboxDto> _callback)
Create an inbox email address.
|
okhttp3.Call |
createInboxCall(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,
ApiCallback _callback)
Build call for createInbox
|
InboxRulesetDto |
createInboxRuleset(UUID inboxId,
CreateInboxRulesetOptions createInboxRulesetOptions)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
okhttp3.Call |
createInboxRulesetAsync(UUID inboxId,
CreateInboxRulesetOptions createInboxRulesetOptions,
ApiCallback<InboxRulesetDto> _callback)
Create an inbox ruleset (asynchronously)
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
okhttp3.Call |
createInboxRulesetCall(UUID inboxId,
CreateInboxRulesetOptions createInboxRulesetOptions,
ApiCallback _callback)
Build call for createInboxRuleset
|
ApiResponse<InboxRulesetDto> |
createInboxRulesetWithHttpInfo(UUID inboxId,
CreateInboxRulesetOptions createInboxRulesetOptions)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
InboxDto |
createInboxWithDefaults()
Create an inbox with default options.
|
okhttp3.Call |
createInboxWithDefaultsAsync(ApiCallback<InboxDto> _callback)
Create an inbox with default options.
|
okhttp3.Call |
createInboxWithDefaultsCall(ApiCallback _callback)
Build call for createInboxWithDefaults
|
ApiResponse<InboxDto> |
createInboxWithDefaultsWithHttpInfo()
Create an inbox with default options.
|
ApiResponse<InboxDto> |
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.
|
InboxDto |
createInboxWithOptions(CreateInboxDto createInboxDto)
Create an inbox with options.
|
okhttp3.Call |
createInboxWithOptionsAsync(CreateInboxDto createInboxDto,
ApiCallback<InboxDto> _callback)
Create an inbox with options.
|
okhttp3.Call |
createInboxWithOptionsCall(CreateInboxDto createInboxDto,
ApiCallback _callback)
Build call for createInboxWithOptions
|
ApiResponse<InboxDto> |
createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto)
Create an inbox with options.
|
void |
deleteAllInboxEmails(UUID inboxId)
Delete all emails in a given inboxes.
|
okhttp3.Call |
deleteAllInboxEmailsAsync(UUID inboxId,
ApiCallback<Void> _callback)
Delete all emails in a given inboxes.
|
okhttp3.Call |
deleteAllInboxEmailsCall(UUID inboxId,
ApiCallback _callback)
Build call for deleteAllInboxEmails
|
ApiResponse<Void> |
deleteAllInboxEmailsWithHttpInfo(UUID inboxId)
Delete all emails in a given inboxes.
|
void |
deleteAllInboxes()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
deleteAllInboxesAsync(ApiCallback<Void> _callback)
Delete all inboxes (asynchronously)
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
deleteAllInboxesCall(ApiCallback _callback)
Build call for deleteAllInboxes
|
ApiResponse<Void> |
deleteAllInboxesWithHttpInfo()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
void |
deleteInbox(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
okhttp3.Call |
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 |
deleteInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for deleteInbox
|
ApiResponse<Void> |
deleteInboxWithHttpInfo(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
InboxExistsDto |
doesInboxExist(String emailAddress,
Boolean allowCatchAll)
Does inbox exist
Check if inboxes exist by email address.
|
okhttp3.Call |
doesInboxExistAsync(String emailAddress,
Boolean allowCatchAll,
ApiCallback<InboxExistsDto> _callback)
Does inbox exist (asynchronously)
Check if inboxes exist by email address.
|
okhttp3.Call |
doesInboxExistCall(String emailAddress,
Boolean allowCatchAll,
ApiCallback _callback)
Build call for doesInboxExist
|
ApiResponse<InboxExistsDto> |
doesInboxExistWithHttpInfo(String emailAddress,
Boolean allowCatchAll)
Does inbox exist
Check if inboxes exist by email address.
|
FlushExpiredInboxesResult |
flushExpired(OffsetDateTime before)
Remove expired inboxes
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
|
okhttp3.Call |
flushExpiredAsync(OffsetDateTime before,
ApiCallback<FlushExpiredInboxesResult> _callback)
Remove expired inboxes (asynchronously)
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
|
okhttp3.Call |
flushExpiredCall(OffsetDateTime before,
ApiCallback _callback)
Build call for flushExpired
|
ApiResponse<FlushExpiredInboxesResult> |
flushExpiredWithHttpInfo(OffsetDateTime before)
Remove expired inboxes
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
|
PageInboxProjection |
getAllInboxes(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.
|
okhttp3.Call |
getAllInboxesAsync(Integer page,
Integer size,
String sort,
Boolean favourite,
String search,
String tag,
Boolean teamAccess,
OffsetDateTime since,
OffsetDateTime before,
String inboxType,
UUID domainId,
ApiCallback<PageInboxProjection> _callback)
List All Inboxes Paginated (asynchronously)
List inboxes in paginated form.
|
okhttp3.Call |
getAllInboxesCall(Integer page,
Integer size,
String sort,
Boolean favourite,
String search,
String tag,
Boolean teamAccess,
OffsetDateTime since,
OffsetDateTime before,
String inboxType,
UUID domainId,
ApiCallback _callback)
Build call for getAllInboxes
|
ApiResponse<PageInboxProjection> |
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.
|
PageScheduledJobs |
getAllScheduledJobs(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.
|
okhttp3.Call |
getAllScheduledJobsAsync(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageScheduledJobs> _callback)
Get all scheduled email sending jobs for account (asynchronously)
Schedule sending of emails using scheduled jobs.
|
okhttp3.Call |
getAllScheduledJobsCall(Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getAllScheduledJobs
|
ApiResponse<PageScheduledJobs> |
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.
|
ApiClient |
getApiClient() |
String |
getCustomBaseUrl() |
PageDeliveryStatus |
getDeliveryStatusesByInboxId(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all email delivery statuses for an inbox
|
okhttp3.Call |
getDeliveryStatusesByInboxIdAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageDeliveryStatus> _callback)
(asynchronously)
Get all email delivery statuses for an inbox
|
okhttp3.Call |
getDeliveryStatusesByInboxIdCall(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getDeliveryStatusesByInboxId
|
ApiResponse<PageDeliveryStatus> |
getDeliveryStatusesByInboxIdWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before)
Get all email delivery statuses for an inbox
|
List<EmailPreview> |
getEmails(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.
|
okhttp3.Call |
getEmailsAsync(UUID inboxId,
Integer size,
Integer limit,
String sort,
Long retryTimeout,
Long delayTimeout,
Long minCount,
Boolean unreadOnly,
OffsetDateTime before,
OffsetDateTime since,
ApiCallback<List<EmailPreview>> _callback)
Get emails in an Inbox.
|
okhttp3.Call |
getEmailsCall(UUID inboxId,
Integer size,
Integer limit,
String sort,
Long retryTimeout,
Long delayTimeout,
Long minCount,
Boolean unreadOnly,
OffsetDateTime before,
OffsetDateTime since,
ApiCallback _callback)
Build call for getEmails
|
ApiResponse<List<EmailPreview>> |
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.
|
int |
getHostIndex() |
ImapSmtpAccessDetails |
getImapSmtpAccess(UUID inboxId)
Get IMAP and SMTP access usernames and passwords
|
okhttp3.Call |
getImapSmtpAccessAsync(UUID inboxId,
ApiCallback<ImapSmtpAccessDetails> _callback)
(asynchronously)
Get IMAP and SMTP access usernames and passwords
|
okhttp3.Call |
getImapSmtpAccessCall(UUID inboxId,
ApiCallback _callback)
Build call for getImapSmtpAccess
|
ApiResponse<ImapSmtpAccessDetails> |
getImapSmtpAccessWithHttpInfo(UUID inboxId)
Get IMAP and SMTP access usernames and passwords
|
InboxDto |
getInbox(UUID inboxId)
Get Inbox.
|
okhttp3.Call |
getInboxAsync(UUID inboxId,
ApiCallback<InboxDto> _callback)
Get Inbox.
|
InboxByEmailAddressResult |
getInboxByEmailAddress(String emailAddress)
Search for an inbox with the provided email address
Get a inbox result by email address
|
okhttp3.Call |
getInboxByEmailAddressAsync(String emailAddress,
ApiCallback<InboxByEmailAddressResult> _callback)
Search for an inbox with the provided email address (asynchronously)
Get a inbox result by email address
|
okhttp3.Call |
getInboxByEmailAddressCall(String emailAddress,
ApiCallback _callback)
Build call for getInboxByEmailAddress
|
ApiResponse<InboxByEmailAddressResult> |
getInboxByEmailAddressWithHttpInfo(String emailAddress)
Search for an inbox with the provided email address
Get a inbox result by email address
|
InboxByNameResult |
getInboxByName(String name)
Search for an inbox with the given name
Get a inbox result by name
|
okhttp3.Call |
getInboxByNameAsync(String name,
ApiCallback<InboxByNameResult> _callback)
Search for an inbox with the given name (asynchronously)
Get a inbox result by name
|
okhttp3.Call |
getInboxByNameCall(String name,
ApiCallback _callback)
Build call for getInboxByName
|
ApiResponse<InboxByNameResult> |
getInboxByNameWithHttpInfo(String name)
Search for an inbox with the given name
Get a inbox result by name
|
okhttp3.Call |
getInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for getInbox
|
CountDto |
getInboxCount()
Get total inbox count
|
okhttp3.Call |
getInboxCountAsync(ApiCallback<CountDto> _callback)
Get total inbox count (asynchronously)
|
okhttp3.Call |
getInboxCountCall(ApiCallback _callback)
Build call for getInboxCount
|
ApiResponse<CountDto> |
getInboxCountWithHttpInfo()
Get total inbox count
|
CountDto |
getInboxEmailCount(UUID inboxId)
Get email count in inbox
|
okhttp3.Call |
getInboxEmailCountAsync(UUID inboxId,
ApiCallback<CountDto> _callback)
Get email count in inbox (asynchronously)
|
okhttp3.Call |
getInboxEmailCountCall(UUID inboxId,
ApiCallback _callback)
Build call for getInboxEmailCount
|
ApiResponse<CountDto> |
getInboxEmailCountWithHttpInfo(UUID inboxId)
Get email count in inbox
|
PageEmailPreview |
getInboxEmailsPaginated(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.
|
okhttp3.Call |
getInboxEmailsPaginatedAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageEmailPreview> _callback)
Get inbox emails paginated (asynchronously)
Get a paginated list of emails in an inbox.
|
okhttp3.Call |
getInboxEmailsPaginatedCall(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getInboxEmailsPaginated
|
ApiResponse<PageEmailPreview> |
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.
|
List<InboxDto> |
getInboxes(Integer size,
String sort,
OffsetDateTime since,
Boolean excludeCatchAllInboxes,
OffsetDateTime before)
Deprecated.
|
okhttp3.Call |
getInboxesAsync(Integer size,
String sort,
OffsetDateTime since,
Boolean excludeCatchAllInboxes,
OffsetDateTime before,
ApiCallback<List<InboxDto>> _callback)
Deprecated.
|
okhttp3.Call |
getInboxesCall(Integer size,
String sort,
OffsetDateTime since,
Boolean excludeCatchAllInboxes,
OffsetDateTime before,
ApiCallback _callback)
Deprecated.
|
ApiResponse<List<InboxDto>> |
getInboxesWithHttpInfo(Integer size,
String sort,
OffsetDateTime since,
Boolean excludeCatchAllInboxes,
OffsetDateTime before)
Deprecated.
|
InboxIdsResult |
getInboxIds()
Get all inbox IDs
Get list of inbox IDs
|
okhttp3.Call |
getInboxIdsAsync(ApiCallback<InboxIdsResult> _callback)
Get all inbox IDs (asynchronously)
Get list of inbox IDs
|
okhttp3.Call |
getInboxIdsCall(ApiCallback _callback)
Build call for getInboxIds
|
ApiResponse<InboxIdsResult> |
getInboxIdsWithHttpInfo()
Get all inbox IDs
Get list of inbox IDs
|
PageSentEmailProjection |
getInboxSentEmails(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.
|
okhttp3.Call |
getInboxSentEmailsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageSentEmailProjection> _callback)
Get Inbox Sent Emails (asynchronously)
Returns an inbox's sent email receipts.
|
okhttp3.Call |
getInboxSentEmailsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getInboxSentEmails
|
ApiResponse<PageSentEmailProjection> |
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.
|
List<String> |
getInboxTags()
Get inbox tags
Get all inbox tags
|
okhttp3.Call |
getInboxTagsAsync(ApiCallback<List<String>> _callback)
Get inbox tags (asynchronously)
Get all inbox tags
|
okhttp3.Call |
getInboxTagsCall(ApiCallback _callback)
Build call for getInboxTags
|
ApiResponse<List<String>> |
getInboxTagsWithHttpInfo()
Get inbox tags
Get all inbox tags
|
ApiResponse<InboxDto> |
getInboxWithHttpInfo(UUID inboxId)
Get Inbox.
|
Email |
getLatestEmailInInbox(UUID inboxId,
Long timeoutMillis)
Get latest email in an inbox.
|
okhttp3.Call |
getLatestEmailInInboxAsync(UUID inboxId,
Long timeoutMillis,
ApiCallback<Email> _callback)
Get latest email in an inbox.
|
okhttp3.Call |
getLatestEmailInInboxCall(UUID inboxId,
Long timeoutMillis,
ApiCallback _callback)
Build call for getLatestEmailInInbox
|
ApiResponse<Email> |
getLatestEmailInInboxWithHttpInfo(UUID inboxId,
Long timeoutMillis)
Get latest email in an inbox.
|
PageOrganizationInboxProjection |
getOrganizationInboxes(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
okhttp3.Call |
getOrganizationInboxesAsync(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageOrganizationInboxProjection> _callback)
List Organization Inboxes Paginated (asynchronously)
List organization inboxes in paginated form.
|
okhttp3.Call |
getOrganizationInboxesCall(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getOrganizationInboxes
|
ApiResponse<PageOrganizationInboxProjection> |
getOrganizationInboxesWithHttpInfo(Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
ScheduledJobDto |
getScheduledJob(UUID jobId)
Get a scheduled email job
Get a scheduled email job details.
|
okhttp3.Call |
getScheduledJobAsync(UUID jobId,
ApiCallback<ScheduledJobDto> _callback)
Get a scheduled email job (asynchronously)
Get a scheduled email job details.
|
okhttp3.Call |
getScheduledJobCall(UUID jobId,
ApiCallback _callback)
Build call for getScheduledJob
|
PageScheduledJobs |
getScheduledJobsByInboxId(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.
|
okhttp3.Call |
getScheduledJobsByInboxIdAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageScheduledJobs> _callback)
Get all scheduled email sending jobs for the inbox (asynchronously)
Schedule sending of emails using scheduled jobs.
|
okhttp3.Call |
getScheduledJobsByInboxIdCall(UUID inboxId,
Integer page,
Integer size,
String sort,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getScheduledJobsByInboxId
|
ApiResponse<PageScheduledJobs> |
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> |
getScheduledJobWithHttpInfo(UUID jobId)
Get a scheduled email job
Get a scheduled email job details.
|
PageInboxRulesetDto |
listInboxRulesets(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
List inbox rulesets
List all rulesets attached to an inbox
|
okhttp3.Call |
listInboxRulesetsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageInboxRulesetDto> _callback)
List inbox rulesets (asynchronously)
List all rulesets attached to an inbox
|
okhttp3.Call |
listInboxRulesetsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for listInboxRulesets
|
ApiResponse<PageInboxRulesetDto> |
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
|
PageTrackingPixelProjection |
listInboxTrackingPixels(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
|
okhttp3.Call |
listInboxTrackingPixelsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageTrackingPixelProjection> _callback)
List inbox tracking pixels (asynchronously)
List all tracking pixels sent from an inbox
|
okhttp3.Call |
listInboxTrackingPixelsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for listInboxTrackingPixels
|
ApiResponse<PageTrackingPixelProjection> |
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
|
void |
sendEmail(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
SentEmailDto |
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 a link to the sent object created for it.
|
okhttp3.Call |
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 a link to the sent object created for it.
|
okhttp3.Call |
sendEmailAndConfirmCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmailAndConfirm
|
ApiResponse<SentEmailDto> |
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.
|
okhttp3.Call |
sendEmailAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback<Void> _callback)
Send Email (asynchronously)
Send an email from an inbox's email address.
|
okhttp3.Call |
sendEmailCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmail
|
ApiResponse<Void> |
sendEmailWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
void |
sendEmailWithQueue(UUID inboxId,
Boolean validateBeforeEnqueue,
SendEmailOptions sendEmailOptions)
Send email with queue
Send an email using a queue.
|
okhttp3.Call |
sendEmailWithQueueAsync(UUID inboxId,
Boolean validateBeforeEnqueue,
SendEmailOptions sendEmailOptions,
ApiCallback<Void> _callback)
Send email with queue (asynchronously)
Send an email using a queue.
|
okhttp3.Call |
sendEmailWithQueueCall(UUID inboxId,
Boolean validateBeforeEnqueue,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmailWithQueue
|
ApiResponse<Void> |
sendEmailWithQueueWithHttpInfo(UUID inboxId,
Boolean validateBeforeEnqueue,
SendEmailOptions sendEmailOptions)
Send email with queue
Send an email using a queue.
|
SentEmailDto |
sendSmtpEnvelope(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.
|
okhttp3.Call |
sendSmtpEnvelopeAsync(UUID inboxId,
SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions,
ApiCallback<SentEmailDto> _callback)
Send email using an SMTP mail envelope and message body and return sent confirmation (asynchronously)
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
|
okhttp3.Call |
sendSmtpEnvelopeCall(UUID inboxId,
SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions,
ApiCallback _callback)
Build call for sendSmtpEnvelope
|
ApiResponse<SentEmailDto> |
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.
|
void |
sendTestEmail(UUID inboxId)
Send a test email to inbox
Send an inbox a test email to test email receiving is working
|
okhttp3.Call |
sendTestEmailAsync(UUID inboxId,
ApiCallback<Void> _callback)
Send a test email to inbox (asynchronously)
Send an inbox a test email to test email receiving is working
|
okhttp3.Call |
sendTestEmailCall(UUID inboxId,
ApiCallback _callback)
Build call for sendTestEmail
|
ApiResponse<Void> |
sendTestEmailWithHttpInfo(UUID inboxId)
Send a test email to inbox
Send an inbox a test email to test email receiving is working
|
ScheduledJobDto |
sendWithSchedule(UUID inboxId,
SendEmailOptions sendEmailOptions,
OffsetDateTime sendAtTimestamp,
Long sendAtNowPlusSeconds,
Boolean validateBeforeEnqueue)
Send email with with delay or schedule
Send an email using a delay.
|
okhttp3.Call |
sendWithScheduleAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
OffsetDateTime sendAtTimestamp,
Long sendAtNowPlusSeconds,
Boolean validateBeforeEnqueue,
ApiCallback<ScheduledJobDto> _callback)
Send email with with delay or schedule (asynchronously)
Send an email using a delay.
|
okhttp3.Call |
sendWithScheduleCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
OffsetDateTime sendAtTimestamp,
Long sendAtNowPlusSeconds,
Boolean validateBeforeEnqueue,
ApiCallback _callback)
Build call for sendWithSchedule
|
ApiResponse<ScheduledJobDto> |
sendWithScheduleWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions,
OffsetDateTime sendAtTimestamp,
Long sendAtNowPlusSeconds,
Boolean validateBeforeEnqueue)
Send email with with delay or schedule
Send an email using a delay.
|
void |
setApiClient(ApiClient apiClient) |
void |
setCustomBaseUrl(String customBaseUrl) |
void |
setHostIndex(int hostIndex) |
InboxDto |
setInboxFavourited(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
okhttp3.Call |
setInboxFavouritedAsync(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback<InboxDto> _callback)
Set inbox favourited state (asynchronously)
Set and return new favourite state for an inbox
|
okhttp3.Call |
setInboxFavouritedCall(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback _callback)
Build call for setInboxFavourited
|
ApiResponse<InboxDto> |
setInboxFavouritedWithHttpInfo(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
InboxDto |
updateInbox(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox.
|
okhttp3.Call |
updateInboxAsync(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback<InboxDto> _callback)
Update Inbox.
|
okhttp3.Call |
updateInboxCall(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback _callback)
Build call for updateInbox
|
ApiResponse<InboxDto> |
updateInboxWithHttpInfo(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox.
|
public InboxControllerApi()
public InboxControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public int getHostIndex()
public void setHostIndex(int hostIndex)
public String getCustomBaseUrl()
public void setCustomBaseUrl(String customBaseUrl)
public okhttp3.Call cancelScheduledJobCall(UUID jobId, ApiCallback _callback) throws ApiException
jobId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public ScheduledJobDto cancelScheduledJob(UUID jobId) throws ApiException
jobId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<ScheduledJobDto> cancelScheduledJobWithHttpInfo(UUID jobId) throws ApiException
jobId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call cancelScheduledJobAsync(UUID jobId, ApiCallback<ScheduledJobDto> _callback) throws ApiException
jobId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call createInboxCall(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, ApiCallback _callback) throws ApiException
emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)favourite - Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)allowTeamAccess - DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)inboxType - HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)virtualInbox - Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)useShortAddress - Use a shorter email address under 31 characters (optional)domainId - ID of custom domain to use for email address. (optional)domainName - FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public InboxDto createInbox(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) throws ApiException
emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)favourite - Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)allowTeamAccess - DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)inboxType - HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)virtualInbox - Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)useShortAddress - Use a shorter email address under 31 characters (optional)domainId - ID of custom domain to use for email address. (optional)domainName - FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<InboxDto> 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) throws ApiException
emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)favourite - Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)allowTeamAccess - DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)inboxType - HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)virtualInbox - Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)useShortAddress - Use a shorter email address under 31 characters (optional)domainId - ID of custom domain to use for email address. (optional)domainName - FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call createInboxAsync(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, ApiCallback<InboxDto> _callback) throws ApiException
emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)favourite - Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)allowTeamAccess - DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)inboxType - HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)virtualInbox - Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)useShortAddress - Use a shorter email address under 31 characters (optional)domainId - ID of custom domain to use for email address. (optional)domainName - FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call createInboxRulesetCall(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, ApiCallback _callback) throws ApiException
inboxId - inboxId (required)createInboxRulesetOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxRulesetDto createInboxRuleset(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions) throws ApiException
inboxId - inboxId (required)createInboxRulesetOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxRulesetDto> createInboxRulesetWithHttpInfo(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions) throws ApiException
inboxId - inboxId (required)createInboxRulesetOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call createInboxRulesetAsync(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, ApiCallback<InboxRulesetDto> _callback) throws ApiException
inboxId - inboxId (required)createInboxRulesetOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call createInboxWithDefaultsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public InboxDto createInboxWithDefaults() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<InboxDto> createInboxWithDefaultsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call createInboxWithDefaultsAsync(ApiCallback<InboxDto> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call createInboxWithOptionsCall(CreateInboxDto createInboxDto, ApiCallback _callback) throws ApiException
createInboxDto - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public InboxDto createInboxWithOptions(CreateInboxDto createInboxDto) throws ApiException
createInboxDto - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<InboxDto> createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto) throws ApiException
createInboxDto - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call createInboxWithOptionsAsync(CreateInboxDto createInboxDto, ApiCallback<InboxDto> _callback) throws ApiException
createInboxDto - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call deleteAllInboxEmailsCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public void deleteAllInboxEmails(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public ApiResponse<Void> deleteAllInboxEmailsWithHttpInfo(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call deleteAllInboxEmailsAsync(UUID inboxId, ApiCallback<Void> _callback) throws ApiException
inboxId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call deleteAllInboxesCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public void deleteAllInboxes()
throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public ApiResponse<Void> deleteAllInboxesWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call deleteAllInboxesAsync(ApiCallback<Void> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call deleteInboxCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public void deleteInbox(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public ApiResponse<Void> deleteInboxWithHttpInfo(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call deleteInboxAsync(UUID inboxId, ApiCallback<Void> _callback) throws ApiException
inboxId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call doesInboxExistCall(String emailAddress, Boolean allowCatchAll, ApiCallback _callback) throws ApiException
emailAddress - Email address (required)allowCatchAll - (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxExistsDto doesInboxExist(String emailAddress, Boolean allowCatchAll) throws ApiException
emailAddress - Email address (required)allowCatchAll - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxExistsDto> doesInboxExistWithHttpInfo(String emailAddress, Boolean allowCatchAll) throws ApiException
emailAddress - Email address (required)allowCatchAll - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call doesInboxExistAsync(String emailAddress, Boolean allowCatchAll, ApiCallback<InboxExistsDto> _callback) throws ApiException
emailAddress - Email address (required)allowCatchAll - (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call flushExpiredCall(OffsetDateTime before, ApiCallback _callback) throws ApiException
before - Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public FlushExpiredInboxesResult flushExpired(OffsetDateTime before) throws ApiException
before - Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<FlushExpiredInboxesResult> flushExpiredWithHttpInfo(OffsetDateTime before) throws ApiException
before - Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call flushExpiredAsync(OffsetDateTime before, ApiCallback<FlushExpiredInboxesResult> _callback) throws ApiException
before - Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getAllInboxesCall(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, UUID domainId, ApiCallback _callback) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)favourite - Optionally filter results for favourites only (optional, default to false)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - DEPRECATED. Optionally filter by team access. (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)inboxType - Optional filter by inbox type (optional)domainId - Optional domain ID filter (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageInboxProjection getAllInboxes(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, UUID domainId) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)favourite - Optionally filter results for favourites only (optional, default to false)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - DEPRECATED. Optionally filter by team access. (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)inboxType - Optional filter by inbox type (optional)domainId - Optional domain ID filter (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageInboxProjection> getAllInboxesWithHttpInfo(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, UUID domainId) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)favourite - Optionally filter results for favourites only (optional, default to false)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - DEPRECATED. Optionally filter by team access. (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)inboxType - Optional filter by inbox type (optional)domainId - Optional domain ID filter (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getAllInboxesAsync(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, UUID domainId, ApiCallback<PageInboxProjection> _callback) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)favourite - Optionally filter results for favourites only (optional, default to false)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - DEPRECATED. Optionally filter by team access. (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)inboxType - Optional filter by inbox type (optional)domainId - Optional domain ID filter (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getAllScheduledJobsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageScheduledJobs getAllScheduledJobs(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageScheduledJobs> getAllScheduledJobsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getAllScheduledJobsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageScheduledJobs> _callback) throws ApiException
page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getDeliveryStatusesByInboxIdCall(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - (required)page - Optional page index in delivery status list pagination (optional, default to 0)size - Optional page size in delivery status list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageDeliveryStatus getDeliveryStatusesByInboxId(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in delivery status list pagination (optional, default to 0)size - Optional page size in delivery status list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageDeliveryStatus> getDeliveryStatusesByInboxIdWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in delivery status list pagination (optional, default to 0)size - Optional page size in delivery status list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getDeliveryStatusesByInboxIdAsync(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageDeliveryStatus> _callback) throws ApiException
inboxId - (required)page - Optional page index in delivery status list pagination (optional, default to 0)size - Optional page size in delivery status list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getEmailsCall(UUID inboxId, Integer size, Integer limit, String sort, Long retryTimeout, Long delayTimeout, Long minCount, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, ApiCallback _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)size - Alias for limit. Assessed first before assessing any passed limit. (optional)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)sort - Sort the results by received date and direction ASC or DESC (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)delayTimeout - (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)unreadOnly - (optional)before - Exclude emails received after this ISO 8601 date time (optional)since - Exclude emails received before this ISO 8601 date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public List<EmailPreview> getEmails(UUID inboxId, Integer size, Integer limit, String sort, Long retryTimeout, Long delayTimeout, Long minCount, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since) throws ApiException
inboxId - Id of inbox that emails belongs to (required)size - Alias for limit. Assessed first before assessing any passed limit. (optional)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)sort - Sort the results by received date and direction ASC or DESC (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)delayTimeout - (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)unreadOnly - (optional)before - Exclude emails received after this ISO 8601 date time (optional)since - Exclude emails received before this ISO 8601 date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<List<EmailPreview>> getEmailsWithHttpInfo(UUID inboxId, Integer size, Integer limit, String sort, Long retryTimeout, Long delayTimeout, Long minCount, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since) throws ApiException
inboxId - Id of inbox that emails belongs to (required)size - Alias for limit. Assessed first before assessing any passed limit. (optional)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)sort - Sort the results by received date and direction ASC or DESC (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)delayTimeout - (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)unreadOnly - (optional)before - Exclude emails received after this ISO 8601 date time (optional)since - Exclude emails received before this ISO 8601 date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getEmailsAsync(UUID inboxId, Integer size, Integer limit, String sort, Long retryTimeout, Long delayTimeout, Long minCount, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, ApiCallback<List<EmailPreview>> _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)size - Alias for limit. Assessed first before assessing any passed limit. (optional)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)sort - Sort the results by received date and direction ASC or DESC (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)delayTimeout - (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)unreadOnly - (optional)before - Exclude emails received after this ISO 8601 date time (optional)since - Exclude emails received before this ISO 8601 date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getImapSmtpAccessCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - Inbox ID (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public ImapSmtpAccessDetails getImapSmtpAccess(UUID inboxId) throws ApiException
inboxId - Inbox ID (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<ImapSmtpAccessDetails> getImapSmtpAccessWithHttpInfo(UUID inboxId) throws ApiException
inboxId - Inbox ID (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getImapSmtpAccessAsync(UUID inboxId, ApiCallback<ImapSmtpAccessDetails> _callback) throws ApiException
inboxId - Inbox ID (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxDto getInbox(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxDto> getInboxWithHttpInfo(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxAsync(UUID inboxId, ApiCallback<InboxDto> _callback) throws ApiException
inboxId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxByEmailAddressCall(String emailAddress, ApiCallback _callback) throws ApiException
emailAddress - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxByEmailAddressResult getInboxByEmailAddress(String emailAddress) throws ApiException
emailAddress - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxByEmailAddressResult> getInboxByEmailAddressWithHttpInfo(String emailAddress) throws ApiException
emailAddress - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxByEmailAddressAsync(String emailAddress, ApiCallback<InboxByEmailAddressResult> _callback) throws ApiException
emailAddress - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxByNameCall(String name, ApiCallback _callback) throws ApiException
name - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxByNameResult getInboxByName(String name) throws ApiException
name - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxByNameResult> getInboxByNameWithHttpInfo(String name) throws ApiException
name - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxByNameAsync(String name, ApiCallback<InboxByNameResult> _callback) throws ApiException
name - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxCountCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public CountDto getInboxCount() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<CountDto> getInboxCountWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxCountAsync(ApiCallback<CountDto> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxEmailCountCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public CountDto getInboxEmailCount(UUID inboxId) throws ApiException
inboxId - Id of inbox that emails belongs to (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<CountDto> getInboxEmailCountWithHttpInfo(UUID inboxId) throws ApiException
inboxId - Id of inbox that emails belongs to (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxEmailCountAsync(UUID inboxId, ApiCallback<CountDto> _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxEmailsPaginatedCall(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by received after given date time (optional)before - Optional filter by received before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageEmailPreview getInboxEmailsPaginated(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by received after given date time (optional)before - Optional filter by received before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageEmailPreview> getInboxEmailsPaginatedWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by received after given date time (optional)before - Optional filter by received before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxEmailsPaginatedAsync(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageEmailPreview> _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by received after given date time (optional)before - Optional filter by received before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxIdsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxIdsResult getInboxIds() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxIdsResult> getInboxIdsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxIdsAsync(ApiCallback<InboxIdsResult> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxSentEmailsCall(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox sent email list pagination (optional, default to 0)size - Optional page size in inbox sent email list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional sent email search (optional)since - Optional filter by sent after given date time (optional)before - Optional filter by sent before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageSentEmailProjection getInboxSentEmails(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox sent email list pagination (optional, default to 0)size - Optional page size in inbox sent email list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional sent email search (optional)since - Optional filter by sent after given date time (optional)before - Optional filter by sent before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageSentEmailProjection> getInboxSentEmailsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox sent email list pagination (optional, default to 0)size - Optional page size in inbox sent email list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional sent email search (optional)since - Optional filter by sent after given date time (optional)before - Optional filter by sent before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxSentEmailsAsync(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageSentEmailProjection> _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox sent email list pagination (optional, default to 0)size - Optional page size in inbox sent email list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional sent email search (optional)since - Optional filter by sent after given date time (optional)before - Optional filter by sent before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxTagsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public List<String> getInboxTags() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<List<String>> getInboxTagsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getInboxTagsAsync(ApiCallback<List<String>> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
@Deprecated public okhttp3.Call getInboxesCall(Integer size, String sort, OffsetDateTime since, Boolean excludeCatchAllInboxes, OffsetDateTime before, ApiCallback _callback) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by created after given date time (optional)excludeCatchAllInboxes - Optional exclude catch all inboxes (optional)before - Optional filter by created before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
@Deprecated public List<InboxDto> getInboxes(Integer size, String sort, OffsetDateTime since, Boolean excludeCatchAllInboxes, OffsetDateTime before) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by created after given date time (optional)excludeCatchAllInboxes - Optional exclude catch all inboxes (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
@Deprecated public ApiResponse<List<InboxDto>> getInboxesWithHttpInfo(Integer size, String sort, OffsetDateTime since, Boolean excludeCatchAllInboxes, OffsetDateTime before) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by created after given date time (optional)excludeCatchAllInboxes - Optional exclude catch all inboxes (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
@Deprecated public okhttp3.Call getInboxesAsync(Integer size, String sort, OffsetDateTime since, Boolean excludeCatchAllInboxes, OffsetDateTime before, ApiCallback<List<InboxDto>> _callback) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Optional filter by created after given date time (optional)excludeCatchAllInboxes - Optional exclude catch all inboxes (optional)before - Optional filter by created before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getLatestEmailInInboxCall(UUID inboxId, Long timeoutMillis, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to get the latest email from (required)timeoutMillis - Timeout milliseconds to wait for latest email (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public Email getLatestEmailInInbox(UUID inboxId, Long timeoutMillis) throws ApiException
inboxId - ID of the inbox you want to get the latest email from (required)timeoutMillis - Timeout milliseconds to wait for latest email (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<Email> getLatestEmailInInboxWithHttpInfo(UUID inboxId, Long timeoutMillis) throws ApiException
inboxId - ID of the inbox you want to get the latest email from (required)timeoutMillis - Timeout milliseconds to wait for latest email (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getLatestEmailInInboxAsync(UUID inboxId, Long timeoutMillis, ApiCallback<Email> _callback) throws ApiException
inboxId - ID of the inbox you want to get the latest email from (required)timeoutMillis - Timeout milliseconds to wait for latest email (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getOrganizationInboxesCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageOrganizationInboxProjection getOrganizationInboxes(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageOrganizationInboxProjection> getOrganizationInboxesWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getOrganizationInboxesAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageOrganizationInboxProjection> _callback) throws ApiException
page - Optional page index in list pagination (optional, default to 0)size - Optional page size in list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getScheduledJobCall(UUID jobId, ApiCallback _callback) throws ApiException
jobId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public ScheduledJobDto getScheduledJob(UUID jobId) throws ApiException
jobId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<ScheduledJobDto> getScheduledJobWithHttpInfo(UUID jobId) throws ApiException
jobId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getScheduledJobAsync(UUID jobId, ApiCallback<ScheduledJobDto> _callback) throws ApiException
jobId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getScheduledJobsByInboxIdCall(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - (required)page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageScheduledJobs getScheduledJobsByInboxId(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageScheduledJobs> getScheduledJobsByInboxIdWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call getScheduledJobsByInboxIdAsync(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageScheduledJobs> _callback) throws ApiException
inboxId - (required)page - Optional page index in scheduled job list pagination (optional, default to 0)size - Optional page size in scheduled job list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)since - Filter by created at after the given timestamp (optional)before - Filter by created at before the given timestamp (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call listInboxRulesetsCall(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox ruleset list pagination (optional, default to 0)size - Optional page size in inbox ruleset list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageInboxRulesetDto listInboxRulesets(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox ruleset list pagination (optional, default to 0)size - Optional page size in inbox ruleset list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageInboxRulesetDto> listInboxRulesetsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox ruleset list pagination (optional, default to 0)size - Optional page size in inbox ruleset list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call listInboxRulesetsAsync(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageInboxRulesetDto> _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox ruleset list pagination (optional, default to 0)size - Optional page size in inbox ruleset list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call listInboxTrackingPixelsCall(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox tracking pixel list pagination (optional, default to 0)size - Optional page size in inbox tracking pixel list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public PageTrackingPixelProjection listInboxTrackingPixels(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox tracking pixel list pagination (optional, default to 0)size - Optional page size in inbox tracking pixel list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<PageTrackingPixelProjection> listInboxTrackingPixelsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
inboxId - (required)page - Optional page index in inbox tracking pixel list pagination (optional, default to 0)size - Optional page size in inbox tracking pixel list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call listInboxTrackingPixelsAsync(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageTrackingPixelProjection> _callback) throws ApiException
inboxId - (required)page - Optional page index in inbox tracking pixel list pagination (optional, default to 0)size - Optional page size in inbox tracking pixel list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)searchFilter - Optional search filter (optional)since - Optional filter by created after given date time (optional)before - Optional filter by created before given date time (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call sendEmailCall(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public void sendEmail(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<Void> sendEmailWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendEmailAsync(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback<Void> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendEmailAndConfirmCall(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public SentEmailDto sendEmailAndConfirm(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<SentEmailDto> sendEmailAndConfirmWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendEmailAndConfirmAsync(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback<SentEmailDto> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendEmailWithQueueCall(UUID inboxId, Boolean validateBeforeEnqueue, SendEmailOptions sendEmailOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)validateBeforeEnqueue - Validate before adding to queue (required)sendEmailOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public void sendEmailWithQueue(UUID inboxId, Boolean validateBeforeEnqueue, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)validateBeforeEnqueue - Validate before adding to queue (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<Void> sendEmailWithQueueWithHttpInfo(UUID inboxId, Boolean validateBeforeEnqueue, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)validateBeforeEnqueue - Validate before adding to queue (required)sendEmailOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendEmailWithQueueAsync(UUID inboxId, Boolean validateBeforeEnqueue, SendEmailOptions sendEmailOptions, ApiCallback<Void> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)validateBeforeEnqueue - Validate before adding to queue (required)sendEmailOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendSmtpEnvelopeCall(UUID inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendSMTPEnvelopeOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public SentEmailDto sendSmtpEnvelope(UUID inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendSMTPEnvelopeOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<SentEmailDto> sendSmtpEnvelopeWithHttpInfo(UUID inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendSMTPEnvelopeOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendSmtpEnvelopeAsync(UUID inboxId, SendSMTPEnvelopeOptions sendSMTPEnvelopeOptions, ApiCallback<SentEmailDto> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendSMTPEnvelopeOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendTestEmailCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public void sendTestEmail(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public ApiResponse<Void> sendTestEmailWithHttpInfo(UUID inboxId) throws ApiException
inboxId - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call sendTestEmailAsync(UUID inboxId, ApiCallback<Void> _callback) throws ApiException
inboxId - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
public okhttp3.Call sendWithScheduleCall(UUID inboxId, SendEmailOptions sendEmailOptions, OffsetDateTime sendAtTimestamp, Long sendAtNowPlusSeconds, Boolean validateBeforeEnqueue, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)sendAtTimestamp - Sending timestamp (optional)sendAtNowPlusSeconds - Send after n seconds (optional)validateBeforeEnqueue - Validate before adding to queue (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public ScheduledJobDto sendWithSchedule(UUID inboxId, SendEmailOptions sendEmailOptions, OffsetDateTime sendAtTimestamp, Long sendAtNowPlusSeconds, Boolean validateBeforeEnqueue) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)sendAtTimestamp - Sending timestamp (optional)sendAtNowPlusSeconds - Send after n seconds (optional)validateBeforeEnqueue - Validate before adding to queue (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public ApiResponse<ScheduledJobDto> sendWithScheduleWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions, OffsetDateTime sendAtTimestamp, Long sendAtNowPlusSeconds, Boolean validateBeforeEnqueue) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)sendAtTimestamp - Sending timestamp (optional)sendAtNowPlusSeconds - Send after n seconds (optional)validateBeforeEnqueue - Validate before adding to queue (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call sendWithScheduleAsync(UUID inboxId, SendEmailOptions sendEmailOptions, OffsetDateTime sendAtTimestamp, Long sendAtNowPlusSeconds, Boolean validateBeforeEnqueue, ApiCallback<ScheduledJobDto> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - (required)sendAtTimestamp - Sending timestamp (optional)sendAtNowPlusSeconds - Send after n seconds (optional)validateBeforeEnqueue - Validate before adding to queue (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
public okhttp3.Call setInboxFavouritedCall(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, ApiCallback _callback) throws ApiException
inboxId - ID of inbox to set favourite state (required)setInboxFavouritedOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxDto setInboxFavourited(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions) throws ApiException
inboxId - ID of inbox to set favourite state (required)setInboxFavouritedOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxDto> setInboxFavouritedWithHttpInfo(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions) throws ApiException
inboxId - ID of inbox to set favourite state (required)setInboxFavouritedOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call setInboxFavouritedAsync(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, ApiCallback<InboxDto> _callback) throws ApiException
inboxId - ID of inbox to set favourite state (required)setInboxFavouritedOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call updateInboxCall(UUID inboxId, UpdateInboxOptions updateInboxOptions, ApiCallback _callback) throws ApiException
inboxId - (required)updateInboxOptions - (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
public InboxDto updateInbox(UUID inboxId, UpdateInboxOptions updateInboxOptions) throws ApiException
inboxId - (required)updateInboxOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public ApiResponse<InboxDto> updateInboxWithHttpInfo(UUID inboxId, UpdateInboxOptions updateInboxOptions) throws ApiException
inboxId - (required)updateInboxOptions - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
public okhttp3.Call updateInboxAsync(UUID inboxId, UpdateInboxOptions updateInboxOptions, ApiCallback<InboxDto> _callback) throws ApiException
inboxId - (required)updateInboxOptions - (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
Copyright © 2023. All rights reserved.