openemail.senders
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
What is known about the organisation behind a sender, the line the reading pane shows under an unfamiliar one, and looking a sender up.
senders.get()
Read what is known about a sender
get(email: string, options?: RequestScope): Promise<SenderProfileResource>Resolves a sentence or two about the organisation behind the domain of an address, the line the reading pane shows under an unfamiliar sender. Only the domain is read, so any address on it gives the same answer, and what is known is kept for the whole workspace.
A domain nobody has looked up yet is a 404. research looks it up.
Parameters
emailstringRequiredAn address of the sender, such as
[email protected].options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
SenderProfileResource, { object: 'sender_profile', domain, about, updatedAt }.
Example
const sender = await openemail.senders.get('[email protected]') console.log(sender.domain, sender.about)Notes
An address with no domain is a 422
invalid_parameteronemail.
Also available in
senders.research()
Look a sender up
research(email: string, options?: RequestScope): Promise<SenderProfileResource>Searches the web for the organisation behind the domain of an address and keeps what it found for the whole workspace, as the reading pane does the first time it shows a sender. A domain that was looked up before is answered from what was kept, and nothing is searched again.
Only the owner of the workspace may look senders up, with a key or an app that is not limited to particular addresses or domains: anything else is a 422 capability_unsupported or a 403 owner_only. A workspace looks up at most 200 senders a day, and the next one is a 429 research_limit_reached. A domain nothing could be found about is a 404.
Parameters
emailstringRequiredAn address of the sender. Only its domain is looked up.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
SenderProfileResource, what was found or what was already known.
Example
const sender = await openemail.senders.research('[email protected]') console.log(sender.about)Notes
The SDK retries it after a network failure, which is safe because a domain that was found is answered from what was kept.