Pre-release. HostCraft is in testing and not yet for sale. These docs describe the current build and may change. Join the waitlist to hear when it launches.

Mail API

Source: daemon/proto/hostcraft/v1/mail.proto

MailService

MailService manages mailboxes, forwarders, autoresponders, Sieve filters, per-domain mail configuration, DKIM, the Postfix queue and Rspamd training. REST: /api/v1/mail.

Method	REST route	Permission	Streaming
`ListMailboxes`	`GET /api/v1/mail/mailboxes`	`MailMailboxRead`	unary
`CreateMailbox`	`POST /api/v1/mail/mailboxes`	`MailMailboxCreate`	unary
`GetMailbox`	`GET /api/v1/mail/mailboxes/{id}`	`MailMailboxRead`	unary
`UpdateMailbox`	`PATCH /api/v1/mail/mailboxes/{id}`	`MailMailboxUpdate`	unary
`DeleteMailbox`	`DELETE /api/v1/mail/mailboxes/{id}`	`MailMailboxDelete`	unary
`SetMailboxPassword`	`POST /api/v1/mail/mailboxes/{id}/password`	`MailMailboxUpdate`	unary
`GetMailboxUsage`	`GET /api/v1/mail/mailboxes/{id}/usage`	`MailMailboxRead`	unary
`CreateWebmailSession`	`POST /api/v1/mail/mailboxes/{id}/webmail-session`	`MailWebmailAccess`	unary
`ListMailboxLogins`	`GET /api/v1/mail/mailboxes/{id}/logins`	`MailMailboxRead`	unary
`CreateMailboxLogin`	`POST /api/v1/mail/mailboxes/{id}/logins`	`MailMailboxUpdate`	unary
`ListForwarders`	`GET /api/v1/mail/forwarders`	`MailForwarderRead`	unary
`CreateForwarder`	`POST /api/v1/mail/forwarders`	`MailForwarderCreate`	unary
`GetForwarder`	`GET /api/v1/mail/forwarders/{id}`	`MailForwarderRead`	unary
`UpdateForwarder`	`PATCH /api/v1/mail/forwarders/{id}`	`MailForwarderUpdate`	unary
`DeleteForwarder`	`DELETE /api/v1/mail/forwarders/{id}`	`MailForwarderDelete`	unary
`ListMailingLists`	`GET /api/v1/mail/lists`	`MailListRead`	unary
`CreateMailingList`	`POST /api/v1/mail/lists`	`MailListWrite`	unary
`GetMailingList`	`GET /api/v1/mail/lists/{id}`	`MailListRead`	unary
`UpdateMailingList`	`PATCH /api/v1/mail/lists/{id}`	`MailListWrite`	unary
`DeleteMailingList`	`DELETE /api/v1/mail/lists/{id}`	`MailListWrite`	unary
`GetAutoresponder`	`GET /api/v1/mail/autoresponders/{mailbox_id}`	`MailMailboxRead`	unary
`SetAutoresponder`	`PUT /api/v1/mail/autoresponders/{mailbox_id}`	`MailAutoresponderSet`	unary
`DeleteAutoresponder`	`DELETE /api/v1/mail/autoresponders/{mailbox_id}`	`MailAutoresponderSet`	unary
`ListFilters`	`GET /api/v1/mail/filters`	`MailFilterRead`	unary
`CreateFilter`	`POST /api/v1/mail/filters`	`MailFilterCreate`	unary
`UpdateFilter`	`PATCH /api/v1/mail/filters/{id}`	`MailFilterUpdate`	unary
`DeleteFilter`	`DELETE /api/v1/mail/filters/{id}`	`MailFilterDelete`	unary
`ReorderFilters`	`POST /api/v1/mail/filters/reorder`	`MailFilterUpdate`	unary
`GetMailDomainConfig`	`GET /api/v1/mail/domains/{domain_id}/config`	`MailDomainConfig`	unary
`UpdateMailDomainConfig`	`PATCH /api/v1/mail/domains/{domain_id}/config`	`MailDomainConfig`	unary
`EnableMailDomain`	`POST /api/v1/mail/domains/{domain_id}/enable`	`MailDomainEnable`	unary
`SetCatchAll`	`POST /api/v1/mail/domains/{domain_id}/catchall`	`MailDomainConfig`	unary
`RemoveCatchAll`	`DELETE /api/v1/mail/domains/{domain_id}/catchall`	`MailDomainConfig`	unary
`GetDKIM`	`GET /api/v1/mail/domains/{domain_id}/dkim`	`MailDKIMRead`	unary
`BeginDKIMRotation`	`POST /api/v1/mail/domains/{domain_id}/dkim/rotate`	`MailDKIMRotate`	unary
`CompleteDKIMRotation`	`POST /api/v1/mail/domains/{domain_id}/dkim/complete`	`MailDKIMRotate`	unary
`ListQueue`	`GET /api/v1/mail/queue`	`MailQueueRead`	unary
`FlushQueue`	`POST /api/v1/mail/queue/flush`	`MailQueueFlush`	unary
`DeleteQueueEntry`	`DELETE /api/v1/mail/queue/{queue_id}`	`MailQueueDelete`	unary
`ReportSpam`	`POST /api/v1/mail/spam/report`	`MailRspamdTrain`	unary
`ReportHam`	`POST /api/v1/mail/ham/report`	`MailRspamdTrain`	unary
`SearchDeliveryLog`	`GET /api/v1/mail/delivery-log`	`MailDeliveryLogRead`	unary
`GetDovecotVersionPins`	`GET /api/v1/mail/dovecot/version-pins`	`MailDovecotVersionRead`	unary
`SetDovecotVersionPins`	`PUT /api/v1/mail/dovecot/version-pins`	`MailDovecotVersionPin`	unary

ListMailboxes

/hostcraft.v1.MailService/ListMailboxes

Request: ListMailboxesRequest
Response: ListMailboxesResponse

CreateMailbox

/hostcraft.v1.MailService/CreateMailbox

Request: CreateMailboxRequest
Response: CreateMailboxResponse

GetMailbox

/hostcraft.v1.MailService/GetMailbox

Request: GetMailboxRequest
Response: Mailbox

UpdateMailbox

/hostcraft.v1.MailService/UpdateMailbox

Request: UpdateMailboxRequest
Response: Mailbox

DeleteMailbox

/hostcraft.v1.MailService/DeleteMailbox

Request: DeleteMailboxRequest
Response: DeleteMailboxResponse

SetMailboxPassword

/hostcraft.v1.MailService/SetMailboxPassword

Request: SetMailboxPasswordRequest
Response: Empty

GetMailboxUsage

/hostcraft.v1.MailService/GetMailboxUsage

Request: GetMailboxUsageRequest
Response: MailboxUsage

CreateWebmailSession

/hostcraft.v1.MailService/CreateWebmailSession

Request: CreateWebmailSessionRequest
Response: WebmailSession

ListMailboxLogins

/hostcraft.v1.MailService/ListMailboxLogins

Request: ListMailboxLoginsRequest
Response: ListMailboxLoginsResponse

CreateMailboxLogin

/hostcraft.v1.MailService/CreateMailboxLogin

Request: CreateMailboxLoginRequest
Response: MailboxLogin

ListForwarders

/hostcraft.v1.MailService/ListForwarders

Request: ListForwardersRequest
Response: ListForwardersResponse

CreateForwarder

/hostcraft.v1.MailService/CreateForwarder

Request: CreateForwarderRequest
Response: Forwarder

GetForwarder

/hostcraft.v1.MailService/GetForwarder

Request: GetForwarderRequest
Response: Forwarder

UpdateForwarder

/hostcraft.v1.MailService/UpdateForwarder

Request: UpdateForwarderRequest
Response: Forwarder

DeleteForwarder

/hostcraft.v1.MailService/DeleteForwarder

Request: DeleteForwarderRequest
Response: Empty

ListMailingLists

/hostcraft.v1.MailService/ListMailingLists

Request: ListMailingListsRequest
Response: ListMailingListsResponse

CreateMailingList

/hostcraft.v1.MailService/CreateMailingList

Request: CreateMailingListRequest
Response: MailingList

GetMailingList

/hostcraft.v1.MailService/GetMailingList

Request: GetMailingListRequest
Response: MailingList

UpdateMailingList

/hostcraft.v1.MailService/UpdateMailingList

Request: UpdateMailingListRequest
Response: MailingList

DeleteMailingList

/hostcraft.v1.MailService/DeleteMailingList

Request: DeleteMailingListRequest
Response: Empty

GetAutoresponder

/hostcraft.v1.MailService/GetAutoresponder

Request: GetAutoresponderRequest
Response: Autoresponder

SetAutoresponder

/hostcraft.v1.MailService/SetAutoresponder

Request: SetAutoresponderRequest
Response: Autoresponder

DeleteAutoresponder

/hostcraft.v1.MailService/DeleteAutoresponder

Request: DeleteAutoresponderRequest
Response: Empty

ListFilters

/hostcraft.v1.MailService/ListFilters

Request: ListFiltersRequest
Response: ListFiltersResponse

CreateFilter

/hostcraft.v1.MailService/CreateFilter

Request: CreateFilterRequest
Response: MailFilter

UpdateFilter

/hostcraft.v1.MailService/UpdateFilter

Request: UpdateFilterRequest
Response: MailFilter

DeleteFilter

/hostcraft.v1.MailService/DeleteFilter

Request: DeleteFilterRequest
Response: Empty

ReorderFilters

/hostcraft.v1.MailService/ReorderFilters

Request: ReorderFiltersRequest
Response: Empty

GetMailDomainConfig

/hostcraft.v1.MailService/GetMailDomainConfig

Request: GetMailDomainConfigRequest
Response: MailDomainConfig

UpdateMailDomainConfig

/hostcraft.v1.MailService/UpdateMailDomainConfig

Request: UpdateMailDomainConfigRequest
Response: MailDomainConfig

EnableMailDomain

/hostcraft.v1.MailService/EnableMailDomain

Request: EnableMailDomainRequest
Response: WorkflowAccepted

SetCatchAll

/hostcraft.v1.MailService/SetCatchAll

Request: SetCatchAllRequest
Response: MailDomainConfig

RemoveCatchAll

/hostcraft.v1.MailService/RemoveCatchAll

Request: RemoveCatchAllRequest
Response: MailDomainConfig

GetDKIM

/hostcraft.v1.MailService/GetDKIM

Request: GetDKIMRequest
Response: DKIMKey

BeginDKIMRotation

BeginDKIMRotation publishes a new selector alongside the active one. Call CompleteDKIMRotation once the new DNS record has propagated.

/hostcraft.v1.MailService/BeginDKIMRotation

Request: BeginDKIMRotationRequest
Response: BeginDKIMRotationResponse

CompleteDKIMRotation

/hostcraft.v1.MailService/CompleteDKIMRotation

Request: CompleteDKIMRotationRequest
Response: CompleteDKIMRotationResponse

ListQueue

/hostcraft.v1.MailService/ListQueue

Request: ListQueueRequest
Response: ListQueueResponse

FlushQueue

/hostcraft.v1.MailService/FlushQueue

Request: FlushQueueRequest
Response: FlushQueueResponse

DeleteQueueEntry

/hostcraft.v1.MailService/DeleteQueueEntry

Request: DeleteQueueEntryRequest
Response: Empty

ReportSpam

/hostcraft.v1.MailService/ReportSpam

Request: TrainMessageRequest
Response: Empty

ReportHam

/hostcraft.v1.MailService/ReportHam

Request: TrainMessageRequest
Response: Empty

SearchDeliveryLog

SearchDeliveryLog is Track Delivery: Postfix delivery outcomes for mail sent from or to the caller's domains. Server admins may omit account_id to search the whole server.

/hostcraft.v1.MailService/SearchDeliveryLog

Request: SearchDeliveryLogRequest
Response: SearchDeliveryLogResponse

GetDovecotVersionPins

/hostcraft.v1.MailService/GetDovecotVersionPins

Request: GetDovecotVersionPinsRequest
Response: DovecotVersionPins

SetDovecotVersionPins

/hostcraft.v1.MailService/SetDovecotVersionPins

Request: SetDovecotVersionPinsRequest
Response: DovecotVersionPins

MailSelfService

MailSelfService is the self service surface for mailbox logins (role mailbox_user): their own mailbox, password, autoresponder, forwarding and filters. REST: /api/v1/mail/self.

Method	REST route	Permission	Streaming
`GetMailSelf`	`GET /api/v1/mail/self`	`MailSelfRead`	unary
`ChangeMailSelfPassword`	`POST /api/v1/mail/self/password`	`MailSelfPasswordChange`	unary
`GetMailSelfAutoresponder`	`GET /api/v1/mail/self/autoresponder`	`MailSelfRead`	unary
`SetMailSelfAutoresponder`	`PUT /api/v1/mail/self/autoresponder`	`MailSelfAutoresponderSet`	unary
`DeleteMailSelfAutoresponder`	`DELETE /api/v1/mail/self/autoresponder`	`MailSelfAutoresponderSet`	unary
`GetMailSelfForwarding`	`GET /api/v1/mail/self/forwarding`	`MailSelfRead`	unary
`SetMailSelfForwarding`	`PUT /api/v1/mail/self/forwarding`	`MailSelfForwardingManage`	unary
`DeleteMailSelfForwarding`	`DELETE /api/v1/mail/self/forwarding`	`MailSelfForwardingManage`	unary
`ListMailSelfFilters`	`GET /api/v1/mail/self/filters`	`MailSelfRead`	unary
`CreateMailSelfFilter`	`POST /api/v1/mail/self/filters`	`MailSelfFilterManage`	unary
`UpdateMailSelfFilter`	`PATCH /api/v1/mail/self/filters/{id}`	`MailSelfFilterManage`	unary
`DeleteMailSelfFilter`	`DELETE /api/v1/mail/self/filters/{id}`	`MailSelfFilterManage`	unary

GetMailSelf

/hostcraft.v1.MailSelfService/GetMailSelf

Request: GetMailSelfRequest
Response: MailSelf

ChangeMailSelfPassword

/hostcraft.v1.MailSelfService/ChangeMailSelfPassword

Request: ChangeMailSelfPasswordRequest
Response: Empty

GetMailSelfAutoresponder

/hostcraft.v1.MailSelfService/GetMailSelfAutoresponder

Request: GetMailSelfAutoresponderRequest
Response: MailSelfAutoresponder

SetMailSelfAutoresponder

/hostcraft.v1.MailSelfService/SetMailSelfAutoresponder

Request: SetMailSelfAutoresponderRequest
Response: MailSelfAutoresponder

DeleteMailSelfAutoresponder

/hostcraft.v1.MailSelfService/DeleteMailSelfAutoresponder

Request: DeleteMailSelfAutoresponderRequest
Response: Empty

GetMailSelfForwarding

/hostcraft.v1.MailSelfService/GetMailSelfForwarding

Request: GetMailSelfForwardingRequest
Response: MailSelfForwarding

SetMailSelfForwarding

/hostcraft.v1.MailSelfService/SetMailSelfForwarding

Request: SetMailSelfForwardingRequest
Response: MailSelfForwarding

DeleteMailSelfForwarding

/hostcraft.v1.MailSelfService/DeleteMailSelfForwarding

Request: DeleteMailSelfForwardingRequest
Response: Empty

ListMailSelfFilters

/hostcraft.v1.MailSelfService/ListMailSelfFilters

Request: ListMailSelfFiltersRequest
Response: ListFiltersResponse

CreateMailSelfFilter

/hostcraft.v1.MailSelfService/CreateMailSelfFilter

Request: CreateMailSelfFilterRequest
Response: MailFilter

UpdateMailSelfFilter

/hostcraft.v1.MailSelfService/UpdateMailSelfFilter

Request: UpdateMailSelfFilterRequest
Response: MailFilter

DeleteMailSelfFilter

/hostcraft.v1.MailSelfService/DeleteMailSelfFilter

Request: DeleteMailSelfFilterRequest
Response: Empty

MailDeliverabilityService

MailDeliverabilityService reports on sending reputation and runs deliverability tests. REST: /api/v1/mail/deliverability.

Method	REST route	Permission	Streaming
`ListPTRChecks`	`GET /api/v1/mail/deliverability/ptr`	`MailDeliverabilityRead`	unary
`ListRBLChecks`	`GET /api/v1/mail/deliverability/rbl`	`MailDeliverabilityRead`	unary
`ListBounceStats`	`GET /api/v1/mail/deliverability/bounce-stats`	`MailDeliverabilityRead`	unary
`ListSpamTrapHits`	`GET /api/v1/mail/deliverability/spam-traps`	`MailDeliverabilityRead`	unary
`ListReputation`	`GET /api/v1/mail/deliverability/reputation`	`MailDeliverabilityRead`	unary
`ListWarmups`	`GET /api/v1/mail/deliverability/warmup`	`MailDeliverabilityRead`	unary
`StartWarmup`	`POST /api/v1/mail/deliverability/warmup`	`MailWarmupManage`	unary
`GetWarmup`	`GET /api/v1/mail/deliverability/warmup/{ip}`	`MailDeliverabilityRead`	unary
`PauseWarmup`	`POST /api/v1/mail/deliverability/warmup/{ip}/pause`	`MailWarmupManage`	unary
`ResumeWarmup`	`POST /api/v1/mail/deliverability/warmup/{ip}/resume`	`MailWarmupManage`	unary
`CancelWarmup`	`DELETE /api/v1/mail/deliverability/warmup/{ip}`	`MailWarmupManage`	unary
`ListMailTests`	`GET /api/v1/mail/deliverability/test`	`MailDeliverabilityRead`	unary
`RunMailTest`	`POST /api/v1/mail/deliverability/test/{domain_id}`	`MailDeliverabilityTest`	unary
`GetMailTest`	`GET /api/v1/mail/deliverability/test/{id}`	`MailDeliverabilityRead`	unary

ListPTRChecks

/hostcraft.v1.MailDeliverabilityService/ListPTRChecks

Request: ListPTRChecksRequest
Response: ListPTRChecksResponse

ListRBLChecks

/hostcraft.v1.MailDeliverabilityService/ListRBLChecks

Request: ListRBLChecksRequest
Response: ListRBLChecksResponse

ListBounceStats

/hostcraft.v1.MailDeliverabilityService/ListBounceStats

Request: ListBounceStatsRequest
Response: ListBounceStatsResponse

ListSpamTrapHits

/hostcraft.v1.MailDeliverabilityService/ListSpamTrapHits

Request: ListSpamTrapHitsRequest
Response: ListSpamTrapHitsResponse

ListReputation

/hostcraft.v1.MailDeliverabilityService/ListReputation

Request: ListReputationRequest
Response: ListReputationResponse

ListWarmups

/hostcraft.v1.MailDeliverabilityService/ListWarmups

Request: ListWarmupsRequest
Response: ListWarmupsResponse

StartWarmup

/hostcraft.v1.MailDeliverabilityService/StartWarmup

Request: StartWarmupRequest
Response: WarmupSchedule

GetWarmup

/hostcraft.v1.MailDeliverabilityService/GetWarmup

Request: WarmupIPRequest
Response: WarmupSchedule

PauseWarmup

/hostcraft.v1.MailDeliverabilityService/PauseWarmup

Request: WarmupIPRequest
Response: Empty

ResumeWarmup

/hostcraft.v1.MailDeliverabilityService/ResumeWarmup

Request: WarmupIPRequest
Response: Empty

CancelWarmup

/hostcraft.v1.MailDeliverabilityService/CancelWarmup

Request: WarmupIPRequest
Response: Empty

ListMailTests

/hostcraft.v1.MailDeliverabilityService/ListMailTests

Request: ListMailTestsRequest
Response: ListMailTestsResponse

RunMailTest

RunMailTest sends a test message from the domain to an external scoring service; poll GetMailTest with the returned id.

/hostcraft.v1.MailDeliverabilityService/RunMailTest

Request: RunMailTestRequest
Response: MailTestResult

GetMailTest

/hostcraft.v1.MailDeliverabilityService/GetMailTest

Request: GetMailTestRequest
Response: MailTestResult

Messages

Autoresponder

Field	Type	Number	Description
`id`	`string`	1	-
`mailbox_id`	`string`	2	-
`subject`	`string`	3	-
`body`	`string`	4	-
`start_at`	`google.protobuf.Timestamp`	5	-
`end_at`	`google.protobuf.Timestamp`	6	-
`enabled`	`bool`	7	-

BeginDKIMRotationRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

BeginDKIMRotationResponse

Field	Type	Number	Description
`workflow_id`	`string`	1	-
`new_selector`	`string`	2	-
`new_public_key`	`string`	3	-
`new_dns_record`	`string`	4	-

BounceStat

Field	Type	Number	Description
`domain_id`	`string`	1	-
`hour`	`google.protobuf.Timestamp`	2	-
`hard`	`int64`	3	-
`soft`	`int64`	4	-
`sent`	`int64`	5	-
`rate`	`double`	6	-
`updated_at`	`google.protobuf.Timestamp`	7	-

ChangeMailSelfPasswordRequest

Field	Type	Number	Description
`current_password`	`string`	1	-
`new_password`	`string`	2	-

CompleteDKIMRotationRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

CompleteDKIMRotationResponse

Field	Type	Number	Description
`active_selector`	`string`	1	-

CreateFilterRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-
`name`	`string`	2	-
`conditions`	`repeated MailFilterCondition`	3	-
`actions`	`repeated MailFilterAction`	4	-
`priority`	`int64`	5	-
`logic_all`	`bool`	6	-
`enabled`	`bool`	7	-

CreateForwarderRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`source`	`string`	3	-
`targets`	`repeated string`	4	-
`keep_local`	`bool`	5	-

CreateMailSelfFilterRequest

Field	Type	Number	Description
`name`	`string`	1	-
`conditions`	`repeated MailFilterCondition`	2	-
`actions`	`repeated MailFilterAction`	3	-
`priority`	`int64`	4	-
`logic_all`	`bool`	5	-
`enabled`	`bool`	6	-

CreateMailboxLoginRequest

Field	Type	Number	Description
`id`	`string`	1	-
`password`	`string`	2	-
`display_name`	`string`	3	-

CreateMailboxRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`local_part`	`string`	3	-
`password`	`string`	4	-
`quota_bytes`	`int64`	5	-

CreateMailboxResponse

Field	Type	Number	Description
`mailbox`	`Mailbox`	1	-
`workflow_id`	`string`	2	-

CreateMailingListRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`name`	`string`	3	local part, or a full address on the domain
`description`	`string`	4	-
`owners`	`repeated string`	5	-
`members`	`repeated string`	6	-
`moderated`	`bool`	7	-

CreateWebmailSessionRequest

Field	Type	Number	Description
`id`	`string`	1	-
`password`	`string`	2	-

DKIMKey

Field	Type	Number	Description
`selector`	`string`	1	-
`public_key`	`string`	2	-
`dns_record`	`string`	3	-

DeleteAutoresponderRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-

DeleteFilterRequest

Field	Type	Number	Description
`id`	`string`	1	-

DeleteForwarderRequest

Field	Type	Number	Description
`id`	`string`	1	-

DeleteMailSelfAutoresponderRequest

No fields.

DeleteMailSelfFilterRequest

Field	Type	Number	Description
`id`	`string`	1	-

DeleteMailSelfForwardingRequest

No fields.

DeleteMailboxRequest

Field	Type	Number	Description
`id`	`string`	1	-
`keep_maildir`	`bool`	2	-

DeleteMailboxResponse

Field	Type	Number	Description
`workflow_id`	`string`	1	-
`logins_removed`	`int64`	2	-

DeleteMailingListRequest

Field	Type	Number	Description
`id`	`string`	1	-

DeleteQueueEntryRequest

Field	Type	Number	Description
`queue_id`	`string`	1	-

DeliveryEvent

Field	Type	Number	Description
`time`	`google.protobuf.Timestamp`	1	-
`queue_id`	`string`	2	-
`message_id`	`string`	3	-
`from`	`string`	4	-
`to`	`string`	5	-
`status`	`string`	6	-
`dsn`	`string`	7	-
`relay`	`string`	8	-
`detail`	`string`	9	-

DovecotVersionPins

Field	Type	Number	Description
`installed`	`string`	1	-
`config_version`	`string`	2	-
`storage_version`	`string`	3	-
`applied`	`optional bool`	4	-

Empty

Empty is returned by RPCs whose REST route answers with an empty object or 204 No Content.

No fields.

EnableMailDomainRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-
`account_id`	`string`	2	-

FlushQueueRequest

No fields.

FlushQueueResponse

Field	Type	Number	Description
`flushed`	`int64`	1	-

Forwarder

Field	Type	Number	Description
`id`	`string`	1	-
`account_id`	`string`	2	-
`domain_id`	`string`	3	-
`source`	`string`	4	-
`targets`	`repeated string`	5	-
`keep_local`	`bool`	6	-
`created_at`	`google.protobuf.Timestamp`	7	-

GetAutoresponderRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-

GetDKIMRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

GetDovecotVersionPinsRequest

No fields.

GetForwarderRequest

Field	Type	Number	Description
`id`	`string`	1	-

GetMailDomainConfigRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

GetMailSelfAutoresponderRequest

No fields.

GetMailSelfForwardingRequest

No fields.

GetMailSelfRequest

No fields.

GetMailTestRequest

Field	Type	Number	Description
`id`	`string`	1	-

GetMailboxRequest

Field	Type	Number	Description
`id`	`string`	1	-

GetMailboxUsageRequest

Field	Type	Number	Description
`id`	`string`	1	-

GetMailingListRequest

Field	Type	Number	Description
`id`	`string`	1	-

ListBounceStatsRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-
`hours`	`int64`	2	-

ListBounceStatsResponse

Field	Type	Number	Description
`stats`	`repeated BounceStat`	1	-

ListFiltersRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-
`limit`	`int64`	2	-
`offset`	`int64`	3	-

ListFiltersResponse

Field	Type	Number	Description
`filters`	`repeated MailFilter`	1	-

ListForwardersRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`limit`	`int64`	3	-
`offset`	`int64`	4	-

ListForwardersResponse

Field	Type	Number	Description
`forwarders`	`repeated Forwarder`	1	-

ListMailSelfFiltersRequest

No fields.

ListMailTestsRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-
`limit`	`int64`	2	-

ListMailTestsResponse

Field	Type	Number	Description
`tests`	`repeated MailTestResult`	1	-

ListMailboxLoginsRequest

Field	Type	Number	Description
`id`	`string`	1	-

ListMailboxLoginsResponse

Field	Type	Number	Description
`logins`	`repeated MailboxLogin`	1	-

ListMailboxesRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`limit`	`int64`	3	-
`offset`	`int64`	4	-

ListMailboxesResponse

Field	Type	Number	Description
`mailboxes`	`repeated Mailbox`	1	-

ListMailingListsRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`domain_id`	`string`	2	-
`limit`	`int64`	3	-
`offset`	`int64`	4	-

ListMailingListsResponse

Field	Type	Number	Description
`lists`	`repeated MailingList`	1	-

ListPTRChecksRequest

No fields.

ListPTRChecksResponse

Field	Type	Number	Description
`checks`	`repeated PTRCheck`	1	-

ListQueueRequest

Field	Type	Number	Description
`state`	`string`	1	-
`limit`	`int64`	2	-
`offset`	`int64`	3	-

ListQueueResponse

Field	Type	Number	Description
`entries`	`repeated QueueEntry`	1	-

ListRBLChecksRequest

No fields.

ListRBLChecksResponse

Field	Type	Number	Description
`checks`	`repeated RBLCheck`	1	-

ListReputationRequest

Field	Type	Number	Description
`ip`	`string`	1	-

ListReputationResponse

Field	Type	Number	Description
`scores`	`repeated SenderScore`	1	-

ListSpamTrapHitsRequest

Field	Type	Number	Description
`limit`	`int64`	1	-

ListSpamTrapHitsResponse

Field	Type	Number	Description
`hits`	`repeated SpamTrapHit`	1	-

ListWarmupsRequest

No fields.

ListWarmupsResponse

Field	Type	Number	Description
`schedules`	`repeated WarmupSchedule`	1	-

MXRecord

Field	Type	Number	Description
`host`	`string`	1	-
`priority`	`uint32`	2	-

MailDomainConfig

Field	Type	Number	Description
`id`	`string`	1	-
`domain_id`	`string`	2	-
`catch_all_target`	`string`	3	-
`mx_managed`	`bool`	4	-
`dkim_active_selector`	`string`	5	-
`spam_threshold`	`double`	6	-
`outbound_relay_host`	`string`	7	-
`outbound_relay_username`	`string`	8	-
`outbound_relay_has_password`	`bool`	9	-
`custom_mx`	`repeated MXRecord`	10	-

MailFilter

Field	Type	Number	Description
`id`	`string`	1	-
`mailbox_id`	`string`	2	-
`name`	`string`	3	-
`conditions`	`repeated MailFilterCondition`	4	-
`actions`	`repeated MailFilterAction`	5	-
`priority`	`int64`	6	-
`logic_all`	`bool`	7	-
`enabled`	`bool`	8	-

MailFilterAction

Field	Type	Number	Description
`kind`	`string`	1	-
`args`	`map<string, string>`	2	-

MailFilterCondition

Field	Type	Number	Description
`field`	`string`	1	-
`operator`	`string`	2	-
`value`	`string`	3	-

MailSelf

Field	Type	Number	Description
`mailbox`	`Mailbox`	1	-
`autoresponder`	`Autoresponder`	2	-
`forwarding`	`Forwarder`	3	-
`filters`	`repeated MailFilter`	4	-

MailSelfAutoresponder

Field	Type	Number	Description
`autoresponder`	`Autoresponder`	1	-

MailSelfForwarding

Field	Type	Number	Description
`forwarding`	`Forwarder`	1	-

MailTestResult

Field	Type	Number	Description
`id`	`string`	1	-
`domain_id`	`string`	2	-
`test_id`	`string`	3	-
`target_address`	`string`	4	-
`phase`	`string`	5	-
`score`	`double`	6	-
`spf_score`	`double`	7	-
`dkim_score`	`double`	8	-
`dmarc_score`	`double`	9	-
`content_score`	`double`	10	-
`blacklist_score`	`double`	11	-
`breakdown`	`google.protobuf.Struct`	12	-
`error_message`	`string`	13	-
`created_at`	`google.protobuf.Timestamp`	14	-
`updated_at`	`google.protobuf.Timestamp`	15	-
`completed_at`	`google.protobuf.Timestamp`	16	-

Mailbox

Field	Type	Number	Description
`id`	`string`	1	-
`account_id`	`string`	2	-
`domain_id`	`string`	3	-
`local_part`	`string`	4	-
`full_address`	`string`	5	-
`password_set`	`bool`	6	-
`quota_bytes`	`int64`	7	-
`used_bytes`	`int64`	8	-
`autoresponder_enabled`	`bool`	9	-
`created_at`	`google.protobuf.Timestamp`	10	-

MailboxLogin

Field	Type	Number	Description
`id`	`string`	1	-
`email`	`string`	2	-
`display_name`	`string`	3	-
`mailbox_id`	`string`	4	-
`created_at`	`string`	5	-
`disabled`	`bool`	6	-

MailboxUsage

Field	Type	Number	Description
`quota_bytes`	`int64`	1	-
`used_bytes`	`int64`	2	-

MailingList

MailingList is a list address with owners and members, delivered by postfix alias expansion. When moderated the list address reaches the owners, who approve a post by resending it to post_address. request_address (-request) always reaches the owners.

Field	Type	Number	Description
`id`	`string`	1	-
`account_id`	`string`	2	-
`domain_id`	`string`	3	-
`address`	`string`	4	-
`description`	`string`	5	-
`owners`	`repeated string`	6	-
`members`	`repeated string`	7	-
`moderated`	`bool`	8	-
`post_address`	`string`	9	-
`request_address`	`string`	10	-
`created_at`	`google.protobuf.Timestamp`	11	-
`updated_at`	`google.protobuf.Timestamp`	12	-

PTRCheck

Field	Type	Number	Description
`ip`	`string`	1	-
`expected_hostname`	`string`	2	-
`ptr_hostname`	`string`	3	-
`matched`	`bool`	4	-
`forward_confirmed`	`bool`	5	-
`error_message`	`string`	6	-
`checked_at`	`google.protobuf.Timestamp`	7	-

QueueEntry

Field	Type	Number	Description
`queue_id`	`string`	1	-
`sender`	`string`	2	-
`recipients`	`repeated string`	3	-
`size`	`int64`	4	-
`queued_at`	`google.protobuf.Timestamp`	5	-
`delay`	`int64`	6	-
`state`	`string`	7	-
`last_error`	`string`	8	-

RBLCheck

Field	Type	Number	Description
`ip`	`string`	1	-
`rbl_name`	`string`	2	-
`listed`	`bool`	3	-
`response`	`string`	4	-
`delisting_url`	`string`	5	-
`checked_at`	`google.protobuf.Timestamp`	6	-

RemoveCatchAllRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

ReorderFiltersRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-
`filter_ids`	`repeated string`	2	-

RunMailTestRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-

SearchDeliveryLogRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`q`	`string`	2	substring of sender, recipient, queue id or message id
`status`	`string`	3	sent \| deferred \| bounced \| expired \| rejected
`hours`	`int64`	4	look back this many hours
`limit`	`int64`	5	-

SearchDeliveryLogResponse

Field	Type	Number	Description
`events`	`repeated DeliveryEvent`	1	-

SenderScore

Field	Type	Number	Description
`ip`	`string`	1	-
`source`	`string`	2	-
`score`	`int64`	3	-
`category`	`string`	4	-
`detail`	`string`	5	-
`checked_at`	`google.protobuf.Timestamp`	6	-

SetAutoresponderRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-
`subject`	`string`	2	-
`body`	`string`	3	-
`start_at`	`google.protobuf.Timestamp`	4	-
`end_at`	`google.protobuf.Timestamp`	5	-
`enabled`	`bool`	6	-

SetCatchAllRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-
`target`	`string`	2	-

SetDovecotVersionPinsRequest

Field	Type	Number	Description
`config_version`	`string`	1	-
`storage_version`	`string`	2	-

SetMailSelfAutoresponderRequest

Field	Type	Number	Description
`subject`	`string`	1	-
`body`	`string`	2	-
`start_at`	`google.protobuf.Timestamp`	3	-
`end_at`	`google.protobuf.Timestamp`	4	-
`enabled`	`bool`	5	-

SetMailSelfForwardingRequest

Field	Type	Number	Description
`targets`	`repeated string`	1	-
`keep_local`	`bool`	2	-

SetMailboxPasswordRequest

Field	Type	Number	Description
`id`	`string`	1	-
`new_password`	`string`	2	-

SpamTrapHit

Field	Type	Number	Description
`id`	`string`	1	-
`domain_id`	`string`	2	-
`mailbox_id`	`string`	3	-
`sender`	`string`	4	-
`recipient`	`string`	5	-
`trap_source`	`string`	6	-
`queue_id`	`string`	7	-
`detected_at`	`google.protobuf.Timestamp`	8	-
`notes`	`string`	9	-

StartWarmupRequest

Field	Type	Number	Description
`ip`	`string`	1	-
`target_volume`	`int64`	2	-

TrainMessageRequest

Field	Type	Number	Description
`mailbox_id`	`string`	1	-
`message_id`	`string`	2	-

UpdateFilterRequest

Field	Type	Number	Description
`id`	`string`	1	-
`name`	`optional string`	2	-
`conditions`	`repeated MailFilterCondition`	3	-
`replace_conditions`	`bool`	4	-
`actions`	`repeated MailFilterAction`	5	-
`replace_actions`	`bool`	6	-
`priority`	`optional int64`	7	-
`logic_all`	`optional bool`	8	-
`enabled`	`optional bool`	9	-

UpdateForwarderRequest

Field	Type	Number	Description
`id`	`string`	1	-
`targets`	`repeated string`	2	replaces the targets when non-empty
`keep_local`	`optional bool`	3	-

UpdateMailDomainConfigRequest

Field	Type	Number	Description
`domain_id`	`string`	1	-
`mx_managed`	`optional bool`	2	-
`spam_threshold`	`optional double`	3	-
`outbound_relay_host`	`optional string`	4	-
`outbound_relay_username`	`optional string`	5	-
`outbound_relay_password`	`optional string`	6	-
`custom_mx`	`repeated MXRecord`	7	-
`replace_custom_mx`	`bool`	8	-

UpdateMailSelfFilterRequest

Field	Type	Number	Description
`id`	`string`	1	-
`name`	`optional string`	2	-
`conditions`	`repeated MailFilterCondition`	3	replaces when non-empty
`actions`	`repeated MailFilterAction`	4	replaces when non-empty
`priority`	`optional int64`	5	-
`logic_all`	`optional bool`	6	-
`enabled`	`optional bool`	7	-

UpdateMailboxRequest

Field	Type	Number	Description
`id`	`string`	1	-
`quota_bytes`	`optional int64`	2	-
`autoresponder_enabled`	`optional bool`	3	-

UpdateMailingListRequest

Field	Type	Number	Description
`id`	`string`	1	-
`description`	`optional string`	2	-
`owners`	`repeated string`	3	replaces the owners when non-empty
`members`	`repeated string`	4	replaces the members when non-empty
`moderated`	`optional bool`	5	-
`clear_members`	`bool`	6	empties the member list

WarmupIPRequest

Field	Type	Number	Description
`ip`	`string`	1	-

WarmupSchedule

Field	Type	Number	Description
`ip`	`string`	1	-
`target_volume`	`int64`	2	-
`current_day`	`int64`	3	-
`current_limit`	`int64`	4	-
`phase`	`string`	5	-
`started_at`	`google.protobuf.Timestamp`	6	-
`last_advanced_at`	`google.protobuf.Timestamp`	7	-
`completed_at`	`google.protobuf.Timestamp`	8	-
`notes`	`string`	9	-

WebmailSession

Field	Type	Number	Description
`token`	`string`	1	-
`url`	`string`	2	-
`expires_at`	`google.protobuf.Timestamp`	3	-

WorkflowAccepted

WorkflowAccepted is the body of every 202 response that only starts a workflow saga. Follow progress with WorkflowService.StreamWorkflow.

Field	Type	Number	Description
`workflow_id`	`string`	1	-