MailApi class

Constructors

MailApi([ApiClient? apiClient])

Properties

apiClient → ApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

bulkArchiveEmails(BulkArchiveRequest bulkArchiveRequest) → Future<BulkArchiveResponse?>

Archive multiple messages (remove the INBOX label).

bulkArchiveEmailsWithHttpInfo(BulkArchiveRequest bulkArchiveRequest) → Future<Response>

Archive multiple messages (remove the INBOX label).

bulkDeleteEmails(BulkDeleteEmailsRequest bulkDeleteEmailsRequest) → Future<BulkDeleteEmailsResponse?>

Delete multiple messages in one call.

bulkDeleteEmailsWithHttpInfo(BulkDeleteEmailsRequest bulkDeleteEmailsRequest) → Future<Response>

Delete multiple messages in one call.

bulkMarkEmailsRead(BulkMarkReadRequest bulkMarkReadRequest) → Future<BulkMarkReadResponse?>

Mark multiple messages read or unread in one call.

bulkMarkEmailsReadWithHttpInfo(BulkMarkReadRequest bulkMarkReadRequest) → Future<Response>

Mark multiple messages read or unread in one call.

createDraft(CreateDraftRequest createDraftRequest, {String? xWorkspaceID}) → Future<DraftResponse?>

Create a draft.

createDraftWithHttpInfo(CreateDraftRequest createDraftRequest, {String? xWorkspaceID}) → Future<Response>

Create a draft.

createEmailLabel(CreateLabelRequest createLabelRequest, {String? accountId, String? xWorkspaceID}) → Future<CreateLabelResponse?>

Create a label.

createEmailLabelWithHttpInfo(CreateLabelRequest createLabelRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Create a label.

createMailTemplate(Map<String, Object> requestBody) → Future<Map<String, Object>?>

Create a mail template.

createMailTemplateWithHttpInfo(Map<String, Object> requestBody) → Future<Response>

Create a mail template.

deleteDraft(String id, {String? accountId, String? xWorkspaceID}) → Future<void>

Delete a draft.

deleteDraftWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete a draft.

deleteEmail(String id, {String? accountId, String? xWorkspaceID}) → Future<SuccessFlag?>

Delete an email.

deleteEmailLabel(String id, {String? accountId, String? xWorkspaceID}) → Future<void>

Delete a label.

deleteEmailLabelWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete a label.

deleteEmailWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete an email.

deleteMailTemplate(String id) → Future<void>

Delete a mail template.

deleteMailTemplateWithHttpInfo(String id) → Future<Response>

Delete a mail template.

getEmail(String id, {String? accountId, String? xWorkspaceID}) → Future<GetEmailResponse?>

Fetch one email.

getEmailAttachment(String messageId, String attachmentId, {String? accountId, String? xWorkspaceID}) → Future<MultipartFile?>

Download an attachment.

getEmailAttachmentWithHttpInfo(String messageId, String attachmentId, {String? accountId, String? xWorkspaceID}) → Future<Response>

Download an attachment.

getEmailThread(String id, {String? accountId, String? xWorkspaceID}) → Future<GetThreadResponse?>

Fetch a thread (the conversation a message belongs to).

getEmailThreadWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch a thread (the conversation a message belongs to).

getEmailWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch one email.

getMailTemplate(String id) → Future<Map<String, Object>?>

Fetch a mail template.

getMailTemplateWithHttpInfo(String id) → Future<Response>

Fetch a mail template.

getMailThreadTracking(String threadId) → Future<Map<String, Object>?>

Read mail-tracking events for a thread (open log, reply log, etc.).

getMailThreadTrackingWithHttpInfo(String threadId) → Future<Response>

Read mail-tracking events for a thread (open log, reply log, etc.).

instantiateMailTemplate(String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Render a template with variables and return the resulting draft.

instantiateMailTemplateWithHttpInfo(String id, Map<String, Object> requestBody) → Future<Response>

Render a template with variables and return the resulting draft.

listDrafts({String? xWorkspaceID, List<String>? accountIds, List<String>? providers, int? limit, String? nextPageToken}) → Future<ListDraftsResponse?>

List drafts across connected mail accounts.

listDraftsWithHttpInfo({String? xWorkspaceID, List<String>? accountIds, List<String>? providers, int? limit, String? nextPageToken}) → Future<Response>

List drafts across connected mail accounts.

listEmailLabels({String? accountId, String? xWorkspaceID}) → Future<ListLabelsResponse?>

List labels on the resolved mail account.

listEmailLabelsWithHttpInfo({String? accountId, String? xWorkspaceID}) → Future<Response>

List labels on the resolved mail account.

listEmails({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, String? query, List<String>? labels, String? folder, int? limit, int? offset}) → Future<ListEmailsResponse?>

List emails across connected mail accounts.

listEmailsWithHttpInfo({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, String? query, List<String>? labels, String? folder, int? limit, int? offset}) → Future<Response>

List emails across connected mail accounts.

listMailTemplates() → Future<Map<String, Object>?>

List the caller's saved mail templates.

listMailTemplatesWithHttpInfo() → Future<Response>

List the caller's saved mail templates.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

replyEmail(String messageId, ReplyEmailRequest replyEmailRequest, {String? xWorkspaceID}) → Future<SendEmailResponse?>

Reply to a specific email.

replyEmailWithHttpInfo(String messageId, ReplyEmailRequest replyEmailRequest, {String? xWorkspaceID}) → Future<Response>

Reply to a specific email.

saveMailTemplate(Map<String, Object> requestBody) → Future<Map<String, Object>?>

Save-or-create endpoint used by the renderer's "save as template" flow. Distinct from POST /v1/mail/templates which is the strict create.

saveMailTemplateWithHttpInfo(Map<String, Object> requestBody) → Future<Response>

Save-or-create endpoint used by the renderer's "save as template" flow. Distinct from POST /v1/mail/templates which is the strict create.

searchEmails(String q, {List<String>? accountIds, List<String>? providers, String? xWorkspaceID, String? from, String? to, String? subject, bool? hasAttachment, bool? isUnread, bool? isStarred, List<String>? labels, DateTime? after, DateTime? before, int? limit, String? nextPageToken}) → Future<SearchEmailsResponse?>

Structured search across connected mail accounts.

searchEmailsWithHttpInfo(String q, {List<String>? accountIds, List<String>? providers, String? xWorkspaceID, String? from, String? to, String? subject, bool? hasAttachment, bool? isUnread, bool? isStarred, List<String>? labels, DateTime? after, DateTime? before, int? limit, String? nextPageToken}) → Future<Response>

Structured search across connected mail accounts.

sendDraft(String id, {String? accountId, String? xWorkspaceID}) → Future<SendEmailResponse?>

Send a draft.

sendDraftWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Send a draft.

sendEmail(SendEmailRequest sendEmailRequest, {String? xWorkspaceID}) → Future<SendEmailResponse?>

Send an email.

sendEmailWithHttpInfo(SendEmailRequest sendEmailRequest, {String? xWorkspaceID}) → Future<Response>

Send an email.

toString() → String

A string representation of this object.

inherited

updateDraft(String id, UpdateDraftRequest updateDraftRequest, {String? accountId, String? xWorkspaceID}) → Future<DraftResponse?>

Update a draft (full replacement of provided fields).

updateDraftWithHttpInfo(String id, UpdateDraftRequest updateDraftRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Update a draft (full replacement of provided fields).

updateEmail(String id, UpdateEmailRequest updateEmailRequest, {String? accountId, String? xWorkspaceID}) → Future<UpdateEmailResponse?>

Update an email (mark read/star, add/remove labels).

updateEmailWithHttpInfo(String id, UpdateEmailRequest updateEmailRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Update an email (mark read/star, add/remove labels).

updateMailTemplate(String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Update a mail template.

updateMailTemplateWithHttpInfo(String id, Map<String, Object> requestBody) → Future<Response>

Update a mail template.

workspaceAddMailMessageLabels(String org, String workspace, String messageId, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceAddMailMessageLabelsWithHttpInfo(String org, String workspace, String messageId, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/{messageId}/labels' operation and returns the Response. Parameters:

workspaceCreateMailDraft(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceCreateMailDraftWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/drafts' operation and returns the Response. Parameters:

workspaceCreateMailLabel(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceCreateMailLabelWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/labels' operation and returns the Response. Parameters:

workspaceDeleteMail(String org, String workspace, String id) → Future<void>

Parameters:

workspaceDeleteMailDraft(String org, String workspace, String id) → Future<void>

Parameters:

workspaceDeleteMailDraftWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id}' operation and returns the Response. Parameters:

workspaceDeleteMailLabel(String org, String workspace, String id) → Future<void>

Parameters:

workspaceDeleteMailLabelWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/mail/labels/{id}' operation and returns the Response. Parameters:

workspaceDeleteMailWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id}' operation and returns the Response. Parameters:

workspaceGetMail(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceGetMailAttachment(String org, String workspace, String messageId, String attachmentId) → Future<Map<String, Object>?>

Parameters:

workspaceGetMailAttachmentWithHttpInfo(String org, String workspace, String messageId, String attachmentId) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/attachment/{messageId}/{attachmentId}' operation and returns the Response. Parameters:

workspaceGetMailById(String org, String workspace, String id) → Future<Map<String, Object>?>

Workspace-scoped renderer-compat alias for mail/email/{id}.

workspaceGetMailByIdWithHttpInfo(String org, String workspace, String id) → Future<Response>

Workspace-scoped renderer-compat alias for mail/email/{id}.

workspaceGetMailDraft(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceGetMailDraftWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id}' operation and returns the Response. Parameters:

workspaceGetMailThread(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceGetMailThreadWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/thread/{id}' operation and returns the Response. Parameters:

workspaceGetMailWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id}' operation and returns the Response. Parameters:

workspaceListMail(String org, String workspace) → Future<Map<String, Object>?>

Parameters:

workspaceListMailDrafts(String org, String workspace) → Future<Map<String, Object>?>

Parameters:

workspaceListMailDraftsWithHttpInfo(String org, String workspace) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/drafts' operation and returns the Response. Parameters:

workspaceListMailLabels(String org, String workspace) → Future<Map<String, Object>?>

Parameters:

workspaceListMailLabelsWithHttpInfo(String org, String workspace) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/labels' operation and returns the Response. Parameters:

workspaceListMailWithHttpInfo(String org, String workspace) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/list' operation and returns the Response. Parameters:

workspacePatchMail(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspacePatchMailWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PATCH /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id}' operation and returns the Response. Parameters:

workspaceRemoveMailMessageLabel(String org, String workspace, String messageId, String labelId) → Future<void>

Parameters:

workspaceRemoveMailMessageLabelWithHttpInfo(String org, String workspace, String messageId, String labelId) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/mail/{messageId}/labels/{labelId}' operation and returns the Response. Parameters:

workspaceReplyMail(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceReplyMailWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/reply' operation and returns the Response. Parameters:

workspaceSearchMail(String org, String workspace, {String? q}) → Future<Map<String, Object>?>

Parameters:

workspaceSearchMailWithHttpInfo(String org, String workspace, {String? q}) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/mail/search' operation and returns the Response. Parameters:

workspaceSendMail(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceSendMailDraft(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceSendMailDraftWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id}/send' operation and returns the Response. Parameters:

workspaceSendMailEmailAlias(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Renderer-compat alias for /mail/send.

workspaceSendMailEmailAliasWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Renderer-compat alias for /mail/send.

workspaceSendMailWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/mail/send' operation and returns the Response. Parameters:

workspaceUpdateMail(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceUpdateMailDraft(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceUpdateMailDraftWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PUT /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id}' operation and returns the Response. Parameters:

workspaceUpdateMailLabel(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceUpdateMailLabelWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PUT /v1/organizations/{org}/workspaces/{workspace}/mail/labels/{id}' operation and returns the Response. Parameters:

workspaceUpdateMailWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PUT /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id}' operation and returns the Response. Parameters:

Operators

operator ==(Object other) → bool

The equality operator.

inherited