Skip to content
Console
On this page

Update a mailbox

Updates a mailbox.

Updates a mailbox.

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox
  • Scope notify:write
  • Effect write — a successful call changes state.
  • Collection mailboxes
  • Query update_mask, allow_missing, validate_only

Request

FieldTypeWhat it is
mailboxMailboxThe mailbox to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
allow_missingboolCreate the mailbox when it does not exist (declarative upsert).
validate_onlyboolValidate and return the result without writing anything.

Mailbox

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}.
metaResourceMetaResource metadata.
specMailboxSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

MailboxSpec

FieldTypeWhat it is
kindMailboxKindConnected or hosted. Required. One of connected, hosted.
addressstringThe address, for example support@example.com. Required.
display_namestringThe From display name of mail sent as this mailbox.
imapMailServerIMAP, for a connected mailbox.
smtpMailServerSMTP submission, for a connected mailbox.
passwordstringThe login password of both servers; write-only, sealed at rest. Never returned again.
append_sentboolSave a copy of mail sent as this mailbox to its Sent folder (IMAP APPEND); off when the provider saves one itself.
backfill_start_timetimestampRead mail received on or after this day on the first poll.
enabledboolPoll and send; a disabled mailbox keeps its records.
auth_kindMailboxAuthKindHow a connected mailbox logs in to both servers; unset means PASSWORD. One of password, oauth.
oauth_providerMailboxOauthProviderThe OAuth provider, for OAUTH; the environment's Mailbox OAuth App of this provider is the client the grant belongs to. With imap or smtp unset the provider's own servers are used: Google imap.gmail.com:993 and smtp.gmail.com:465, Microsoft outlook.office365.com:993 and smtp.office365.com:587 (STARTTLS). One of google, microsoft.
oauth_refresh_tokenstringThe OAuth refresh token, for OAUTH; write-only, sealed at rest like the password, never returned. A connect link sets it without the caller ever holding it; a caller that ran its own consent may set it directly, when the token was issued to the environment's Mailbox OAuth App. Never returned again.

MailServer

FieldTypeWhat it is
hoststringThe host name. Required.
portint32The port; IMAP 993 and SMTP 465 when unset.
usernamestringThe login user; the mailbox address when unset.
securityMailServerSecurityHow the connection is secured. One of tls, starttls.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}.
uidstringmbx_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specMailboxSpecDesired state. Required.
statusMailboxStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

MailboxSpec

FieldTypeWhat it is
kindMailboxKindConnected or hosted. Required. One of connected, hosted.
addressstringThe address, for example support@example.com. Required.
display_namestringThe From display name of mail sent as this mailbox.
imapMailServerIMAP, for a connected mailbox.
smtpMailServerSMTP submission, for a connected mailbox.
passwordstringThe login password of both servers; write-only, sealed at rest. Never returned again.
append_sentboolSave a copy of mail sent as this mailbox to its Sent folder (IMAP APPEND); off when the provider saves one itself.
backfill_start_timetimestampRead mail received on or after this day on the first poll.
enabledboolPoll and send; a disabled mailbox keeps its records.
auth_kindMailboxAuthKindHow a connected mailbox logs in to both servers; unset means PASSWORD. One of password, oauth.
oauth_providerMailboxOauthProviderThe OAuth provider, for OAUTH; the environment's Mailbox OAuth App of this provider is the client the grant belongs to. With imap or smtp unset the provider's own servers are used: Google imap.gmail.com:993 and smtp.gmail.com:465, Microsoft outlook.office365.com:993 and smtp.office365.com:587 (STARTTLS). One of google, microsoft.
oauth_refresh_tokenstringThe OAuth refresh token, for OAUTH; write-only, sealed at rest like the password, never returned. A connect link sets it without the caller ever holding it; a caller that ran its own consent may set it directly, when the token was issued to the environment's Mailbox OAuth App. Never returned again.

MailboxStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
password_setboolWhether a password is stored. Output only.
last_poll_timetimestampWhen the mailbox was last read. Output only.
last_errorstringThe last poll's error; empty after a clean poll. Output only.
sent_folderstringThe Sent folder found on the server. Output only.
oauth_refresh_token_setboolWhether an OAuth refresh token is stored. Output only.
oauth_scopesstring[]The scopes the provider granted. Output only.
reconnect_requiredboolThe provider refused the refresh token (revoked, expired, or the account's password changed): the mailbox neither polls nor sends until a connect link naming it, or a new oauth_refresh_token, reconnects it. Output only.

MailServer

FieldTypeWhat it is
hoststringThe host name. Required.
portint32The port; IMAP 993 and SMTP 465 when unset.
usernamestringThe login user; the mailbox address when unset.
securityMailServerSecurityHow the connection is secured. One of tls, starttls.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/mailboxes/mailbox","spec":{"address":"…","kind":"connected"}}'