connections
List Connections
List this organization's connections, ordered by provider, then group, then
name. Use when checking which connections exist, or finding one person's
connection before adding or removing it. Every filter is optional and they
combine: group, subject_number and
subject_ref match exactly (a number in any spelling of the same international
number), which is how your own system finds a person's connection before adding
or removing it; search matches a fragment of the connection's name, number or
reference.
query Parameters
providergroupsubject_numbersubject_refsearchList Connections › Responses
Successful Response
account_labelcapabilitiesWhat a google connection may do, in the words the person picked
from, and empty for every other provider.
scopes is on this shape too and stays: it is what the grant literally
holds, including anything Google volunteered that this platform never
asked about. But a scope URL is this module's vocabulary and not a
person's, and connections.md is explicit that what a connection may do is
offered "never as the provider's own vocabulary for the same thing" -- so
the reading in the client's words travels with the row rather than
leaving a dashboard to spell https://www.googleapis.com/auth/... back
at them.
created_atgranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
idproductsWhich Google products this connection is authorized for, and empty for every other provider -- which has no such division, rather than one this would have to invent a word for.
A reading of scopes and never a column, for the reason
GoogleProduct gives: what a connection is for is what its grant
reaches, so a stored copy would be a second place for one fact and the
first of the two to go stale. Computed here rather than filled in by the
service because every path that hands a connection out goes through this
class, and one of them would eventually forget.
providerscopesstatusWhether the grant is currently usable.
updated_atper_personCreate Connection
Register a connection: one authorization to one outside provider, held by the
platform and pointed at by any number of tools. Use for every credential a tool
needs to reach an outside system,
including the API key of the client's own system (provider http_key, whose
grant_secret is a JSON string with header, prefix and value). A tool never
carries a credential: an HTTP tool whose configuration holds a key or an auth
header is refused, so create the connection first and pass its id as the tool's
connection_id. The secret is never returned.
When the account is one person's -- each salesperson with their own key to your
CRM -- say on whose behalf it acts: a group of your own ("Sales CRM"), and the
person's subject_number (a full international phone number) and/or
subject_ref (their id in your system, at most 128 characters). A tool pointing
at the group then runs with the key of whoever the conversation is with. A
number or reference without a group is refused (422), and a second connection
in the same group with the same number or reference is refused (409). These
fields are believed because the key is your organization's: call this from your
server, never from a browser or an app, which could claim to be anybody.
Create Connection › Request Body
account_labelprovidergranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
per_personscopesCreate Connection › Responses
Successful Response
account_labelcapabilitiesWhat a google connection may do, in the words the person picked
from, and empty for every other provider.
scopes is on this shape too and stays: it is what the grant literally
holds, including anything Google volunteered that this platform never
asked about. But a scope URL is this module's vocabulary and not a
person's, and connections.md is explicit that what a connection may do is
offered "never as the provider's own vocabulary for the same thing" -- so
the reading in the client's words travels with the row rather than
leaving a dashboard to spell https://www.googleapis.com/auth/... back
at them.
created_atgranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
idproductsWhich Google products this connection is authorized for, and empty for every other provider -- which has no such division, rather than one this would have to invent a word for.
A reading of scopes and never a column, for the reason
GoogleProduct gives: what a connection is for is what its grant
reaches, so a stored copy would be a second place for one fact and the
first of the two to go stale. Computed here rather than filled in by the
service because every path that hands a connection out goes through this
class, and one of them would eventually forget.
providerscopesstatusWhether the grant is currently usable.
updated_atper_personCreate Forwarded Address
Connect a dedicated email address of the organization -- the one its
customers write to, never a person's own mailbox -- with no password and no
grant. Answers the address to forward it to (forwarded_to), mails the address
once so the forward can be proved when that mail comes back, and asks the
mail service about the address's domain, whose state is shown and holds
nothing back. Once the forward is proved (health is working), answers
leave from forwarded_to under the sender's name -- the organization's name
when none is set -- never as the address itself. An address is connected
once, in one organization only (409).
Create Forwarded Address › Request Body
Create Forwarded Address › Responses
Successful Response
account_labeladdressconnection_iddomaindomain_stateWhat the platform's mail service last said of the address's domain.
unchecked until anybody asked; not_registered while the mail service
holds no sending domain for it -- every client domain today, with no
records to show, until per-client sending domains land (#1555);
unverified while the records the client must add are not all found;
verified once they are. Shown, and holding nothing back: no state lets or
stops a send, since nothing leaves as the address -- answers leave from the
address the platform gave the connection (rules 53-54, email-threads.md
rule 28).
forwarded_tohealthA forwarded address's health is its forward (rule 54): waiting for the
forward, then working once it is proved, whatever its domain's state, which
is DomainState and shown beside it -- or broken, when the connection is
marked so.
on_disconnectCreate Mail Server
Connect a dedicated email address of the organization -- never a person's
own mailbox -- with its mailbox's password, on the reading (IMAP) and sending
(SMTP) servers you confirmed. An app password is recommended where the
provider offers one. The password is sealed at once and never shown back; the
connection is then tested (health testing): a test message is sent from the
address to itself and looked for, for up to 10 minutes, and it works only once
found -- or is refused with the reason. An address at Google or Microsoft
is refused (422) with refusal: "signed_in_provider" and provider (google
or microsoft); a server inside a private network or off the road's ports,
or a body missing a field, is refused (422) naming no value; an address
connected already is refused (409).
Create Mail Server › Request Body
Create Mail Server › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameDiscover Mail Server
Find the reading (IMAP) and sending (SMTP) servers of a dedicated address
on a hosting or its own server, from what its domain or its provider publishes
for mail apps -- to show and confirm before giving the password. Answers no
servers when nothing is found (enter them by hand). An address whose mail is at
Google or Microsoft is refused (422) with refusal: "signed_in_provider" and
provider (google or microsoft) beside detail: connect it by signing in
or forwarding.
Discover Mail Server › Request Body
addressDiscover Mail Server › Responses
Successful Response
addresssourceWhere the proposed servers were found (rule 6): the domain's own autoconfig, Thunderbird's database of providers (by the domain, or by the provider its mail goes to), the domain's SRV records, or nowhere -- the member enters them.
usernameAuthorize Microsoft Mailbox
Begin connecting a dedicated address's Microsoft mailbox, work or personal, by signing in as that mailbox itself -- never as a person who can open it. Answers the page to open, valid for ten minutes, and the approval page to pass on to an administrator if Microsoft asks for one. atteq asks only to read the mail that reaches the mailbox and to send as it. The sign-in must be finished in the browser that called this: the answer sets a short-lived cookie the callback requires.
Authorize Microsoft Mailbox › Request Body
Authorize Microsoft Mailbox › Responses
Successful Response
admin_approval_urladmin_noteurlList Providers
Which providers declare something for every connection of theirs: whether a connection of each may be per person (connections.md rule 34). Use before offering a per-person connection, to know which providers allow one. A provider not listed declares nothing, and may not be per person.
List Providers › Responses
Successful Response
per_personproviderGet Connection
Read one connection of this organization: the provider and authorized account, its scopes, on whose behalf it acts (group, number, reference) or whether it holds one grant per roster entry, and its health with the reason. The credential itself is never returned.
path Parameters
connection_idGet Connection › Responses
Successful Response
account_labelcapabilitiesWhat a google connection may do, in the words the person picked
from, and empty for every other provider.
scopes is on this shape too and stays: it is what the grant literally
holds, including anything Google volunteered that this platform never
asked about. But a scope URL is this module's vocabulary and not a
person's, and connections.md is explicit that what a connection may do is
offered "never as the provider's own vocabulary for the same thing" -- so
the reading in the client's words travels with the row rather than
leaving a dashboard to spell https://www.googleapis.com/auth/... back
at them.
created_atgranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
idproductsWhich Google products this connection is authorized for, and empty for every other provider -- which has no such division, rather than one this would have to invent a word for.
A reading of scopes and never a column, for the reason
GoogleProduct gives: what a connection is for is what its grant
reaches, so a stored copy would be a second place for one fact and the
first of the two to go stale. Computed here rather than filled in by the
service because every path that hands a connection out goes through this
class, and one of them would eventually forget.
providerscopesstatusWhether the grant is currently usable.
updated_atper_personDelete Connection
Delete a provider connection permanently. Use when the credential should stop existing, such as for a person who has left. Refused while a tool or a channel still uses it; the refusal names each one, to repoint or remove first. For a person who has left, this is how your own system removes their key: a tool pointing at their group then finds no connection for them and fails naming the group, rather than using anybody else's. A Google account's authorization is withdrawn at Google as well; the delete goes through even when Google refuses or cannot be reached. A signed-in mailbox takes nothing more at once; Microsoft offers no way to withdraw atteq there, so the mailbox or its administrator removes it.
path Parameters
connection_idDelete Connection › Responses
Successful Response
Update Connection
Change a provider connection's settings. Use when an existing connection's
group or subject needs to change, not its secret. An explicit null on group,
subject_number or subject_ref clears it; a subject left without a group is
refused (422), and one another connection in the group already acts for is a
conflict (409). Call it from your server, never from a browser.
path Parameters
connection_idUpdate Connection › Request Body
Update Connection › Responses
Successful Response
account_labelcapabilitiesWhat a google connection may do, in the words the person picked
from, and empty for every other provider.
scopes is on this shape too and stays: it is what the grant literally
holds, including anything Google volunteered that this platform never
asked about. But a scope URL is this module's vocabulary and not a
person's, and connections.md is explicit that what a connection may do is
offered "never as the provider's own vocabulary for the same thing" -- so
the reading in the client's words travels with the row rather than
leaving a dashboard to spell https://www.googleapis.com/auth/... back
at them.
created_atgranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
idproductsWhich Google products this connection is authorized for, and empty for every other provider -- which has no such division, rather than one this would have to invent a word for.
A reading of scopes and never a column, for the reason
GoogleProduct gives: what a connection is for is what its grant
reaches, so a stored copy would be a second place for one fact and the
first of the two to go stale. Computed here rather than filled in by the
service because every path that hands a connection out goes through this
class, and one of them would eventually forget.
providerscopesstatusWhether the grant is currently usable.
updated_atper_personGet Forwarded Address
Read a forwarded address's state: its health (waiting for the forward, working once the forward is proved, or broken), the address to forward it to and answer from, the code the client's mail provider sent to confirm the forward while it waits, the DNS records and whether the mail service found them -- shown, never holding the connection back.
path Parameters
connection_idGet Forwarded Address › Responses
Successful Response
account_labeladdressconnection_iddomaindomain_stateWhat the platform's mail service last said of the address's domain.
unchecked until anybody asked; not_registered while the mail service
holds no sending domain for it -- every client domain today, with no
records to show, until per-client sending domains land (#1555);
unverified while the records the client must add are not all found;
verified once they are. Shown, and holding nothing back: no state lets or
stops a send, since nothing leaves as the address -- answers leave from the
address the platform gave the connection (rules 53-54, email-threads.md
rule 28).
forwarded_tohealthA forwarded address's health is its forward (rule 54): waiting for the
forward, then working once it is proved, whatever its domain's state, which
is DomainState and shown beside it -- or broken, when the connection is
marked so.
on_disconnectCheck Forwarded Address
Check a forwarded address's proof again: mail the address once more while
its forward waits (at most once a minute, and 20 times a day for the
organization), and ask the mail service to look for the domain's records.
Always answers the current state; check_note says what was not done and
why, the mail service refusing or unreachable included.
path Parameters
connection_idCheck Forwarded Address › Responses
Successful Response
account_labeladdressconnection_iddomaindomain_stateWhat the platform's mail service last said of the address's domain.
unchecked until anybody asked; not_registered while the mail service
holds no sending domain for it -- every client domain today, with no
records to show, until per-client sending domains land (#1555);
unverified while the records the client must add are not all found;
verified once they are. Shown, and holding nothing back: no state lets or
stops a send, since nothing leaves as the address -- answers leave from the
address the platform gave the connection (rules 53-54, email-threads.md
rule 28).
forwarded_tohealthA forwarded address's health is its forward (rule 54): waiting for the
forward, then working once it is proved, whatever its domain's state, which
is DomainState and shown beside it -- or broken, when the connection is
marked so.
on_disconnectList Person Grants
Read which roster entries hold a grant on a per-person connection, and whether each still works. Use when showing who already has a key on a per-person connection -- every entry's for an owner or an admin, your own for a member. Never a secret.
path Parameters
connection_idList Person Grants › Responses
Successful Response
created_atdisplay_namegranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
roster_entry_idstatusWhether the grant is currently usable.
updated_atSet Person Grant
Set or replace one roster entry's grant on a per-person connection. Use
when pushing or updating one employee's own key on a per-person connection:
an owner or an admin for anyone, a member for themselves. With an API key the caller
has its creator's role, so the client's own system can push each employee's
key with a key an owner or an admin made -- from your server, never from a
browser or an app. grant_secret is what the provider takes (for http_key,
a JSON string with header, prefix and value). The secret is never shown
back; a replaced grant is healthy again.
path Parameters
connection_idroster_entry_idSet Person Grant › Request Body
grant_secretSet Person Grant › Responses
Successful Response
created_atdisplay_namegranted_viaWhich door the grant arrived by.
The spec's "a grant can arrive by more than one door, and the connection is the same whichever it came through": this is the record of the door, and nothing in this slice or above it branches on it.
roster_entry_idstatusWhether the grant is currently usable.
updated_atRemove Person Grant
Remove one roster entry's grant from a per-person connection. Use when an employee's key should stop working, under the same rule of who may. A grant obtained through Google's consent screen is withdrawn at Google as well.
path Parameters
connection_idroster_entry_idRemove Person Grant › Responses
Successful Response
Get Mail Server
Read a mailbox-on-its-own-server connection's state: being tested, working, refused by its test or broken, with the reason and the server meant; its servers; when it was proved and last read; and its sent folder.
path Parameters
connection_idGet Mail Server › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameUpdate Mail Server
Change the name recipients see as the sender, or the subject of a
conversation the organization starts (null clears one; with no sender
name, recipients see the organization's name), or the folder read instead of
the inbox: the id of one folder from the mailbox's own list, null for the
inbox. A changed folder is read from that moment on, never what it held
before; junk is always read. A folder not on the list is refused (422). Also
what atteq does in the mailbox once a conversation answered its mail:
acts_in_mailbox, file it in answered_folder (one folder of the list other
than the folder read, null files nothing), mark it read
(mark_answered_read). The first reply after switching on also files that
conversation's older mail still in the folder read. atteq never deletes mail,
and neither is charged.
path Parameters
connection_idUpdate Mail Server › Request Body
acts_in_mailboxmark_answered_readUpdate Mail Server › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameList Mail Server Folders
List the mailbox's own folders that may be read instead of the inbox, as atteq last read them from its server (when it was proved, and every few minutes while it is read): each with its id, name and where it sits, and when the list was read. Junk, sent mail, drafts, deleted mail and the inbox itself are never listed.
path Parameters
connection_idList Mail Server Folders › Responses
Successful Response
Enter Mail Server Password
Enter a mailbox's password again -- after it was changed at the provider, or when the connection asks for it. Sealed at once, never shown back; the connection is tested again and reads or sends nothing until the test passes, then reads on from where it last read.
path Parameters
connection_idEnter Mail Server Password › Request Body
Enter Mail Server Password › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameChange Mail Server Servers
Change a mailbox's reading or sending server, or its user name, with its password given again for them. The connection is tested again and reads or sends nothing until the test passes.
path Parameters
connection_idChange Mail Server Servers › Request Body
Change Mail Server Servers › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameTest Mail Server Again
Test a mailbox's connection again with what it holds -- after a server's certificate was fixed, or when a server could not be reached or the test message did not arrive. It reads or sends nothing until the test passes.
path Parameters
connection_idTest Mail Server Again › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idhealthWhat the connection shows (rules 10, 13, 17): being tested, working,
refused by its last test (the values kept for the member to correct), or
broken in use. Only working reads or sends.
mark_answered_readon_disconnectThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
One server: its name, its port and how the connection to it is encrypted
(rule 2). Checked by the service, not here (MailServerIn's reason): the
name is a host name or an IP literal (mail_host), the port one of the
road's (READING_PORTS, SENDING_PORTS).
usernameGet Microsoft Mailbox
Read a signed-in mailbox's state: its address, whether it works or broke and why, since when its mail is taken, the moment before which mail was not read after a long break, and where atteq is removed at Microsoft.
path Parameters
connection_idGet Microsoft Mailbox › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idconsented_athealthA signed-in mailbox works from the moment of consent and breaks only on the provider's word (rule 64).
mark_answered_readon_disconnecton_opt_outThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
scopesworking_sincewrite_consentMicrosoft's second consent, to change mail (connections.md rule 60): never asked, given, or refused by Microsoft since -- which stops the acting and nothing else (email-threads.md rule 37).
mirrors_draftsUpdate Microsoft Mailbox
Change the subject of a conversation the organization starts from the
mailbox (null clears it), or the folder read instead of the inbox: the id
of one folder from the mailbox's own list, null for the inbox. A changed
folder is read from that moment on, never what it held before; junk is always
read. A folder not on the list is refused (422). Also what atteq does in the
mailbox once a conversation answered its mail: file it in answered_folder
(one folder of the list other than the folder read, null files nothing),
mark it read (mark_answered_read); acts_in_mailbox false stops both and
forgets the permission to change mail, true needs that permission given first
(409). The first reply after switching on also files that conversation's older
mail still in the folder read. atteq never deletes mail, and neither is charged.
path Parameters
connection_idUpdate Microsoft Mailbox › Request Body
acts_in_mailboxmark_answered_readmirrors_draftsUpdate Microsoft Mailbox › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idconsented_athealthA signed-in mailbox works from the moment of consent and breaks only on the provider's word (rule 64).
mark_answered_readon_disconnecton_opt_outThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
scopesworking_sincewrite_consentMicrosoft's second consent, to change mail (connections.md rule 60): never asked, given, or refused by Microsoft since -- which stops the acting and nothing else (email-threads.md rule 37).
mirrors_draftsList Microsoft Mailbox Folders
List the signed-in mailbox's own folders that may be read instead of the inbox, read at Microsoft now: each with its id, name and where it sits. The inbox itself, junk, sent mail, drafts, deleted mail and the outbox are never listed. 502 when Microsoft could not be asked.
path Parameters
connection_idList Microsoft Mailbox Folders › Responses
Successful Response
Consent To Microsoft Mailbox Writes
Begin switching on atteq filing and marking read, in a signed-in Microsoft
mailbox, the mail its conversations answered -- or, with for_drafts, keeping
each conversation's prepared reply in the mailbox's drafts too: Microsoft
asks, on its own screen and apart from the first sign-in, for permission to
change the mailbox's mail, signed in as that same mailbox; one permission
serves both. Answers the page to open, valid for ten minutes, and the
approval page to pass on should the administrator have to approve it. Once
on, a conversation's first reply also files its older mail still in the
folder read. atteq never deletes mail but its own unchanged drafts. Finish in
the browser that called this: the answer sets a short-lived cookie the
callback requires.
path Parameters
connection_idquery Parameters
for_draftsConsent To Microsoft Mailbox Writes › Responses
Successful Response
admin_approval_urladmin_noteurlWithdraw Microsoft Mailbox Writes
Stop atteq filing and marking read mail in a signed-in Microsoft mailbox, and keeping prepared replies in its drafts -- those already there stay -- and forget its permission to change mail. Reading and sending go on. The answer says where that permission is removed at Microsoft too.
path Parameters
connection_idWithdraw Microsoft Mailbox Writes › Responses
Successful Response
account_labelacts_in_mailboxaddressThe folder the mail a thread answered is filed in (email-threads.md rule
36): id as MailFolderOut gives it and its name, both None while
nothing is filed.
connection_idconsented_athealthA signed-in mailbox works from the moment of consent and breaks only on the provider's word (rule 64).
mark_answered_readon_disconnecton_opt_outThe folder a mailbox is read in (email-threads.md rule 35): id and name
of the one chosen instead of the inbox, both None while the inbox is read;
since when the choice last changed -- what reached the folder before it is
never read -- None while it never did.
scopesworking_sincewrite_consentMicrosoft's second consent, to change mail (connections.md rule 60): never asked, given, or refused by Microsoft since -- which stops the acting and nothing else (email-threads.md rule 37).
mirrors_drafts