پرش به مستندات
Go

client.Senders

هر متد در این فضای نام: امضا، پارامترها، آنچه برمی‌گرداند و یک نمونه.

متدها

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

محدوده‌های دسترسیthreads:read
امضای متد
Get(ctx context.Context, email string, opts ...openemail.RequestOption) (openemail.Object, error)

Returns 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, a subdomain such as mail.stripe.com included, and domain names the organisation's own domain. What is known is shared by every workspace and looked up again by itself once it is 30 days old.

A domain nobody has looked up yet is a 404, and so are personal mailbox providers such as Gmail and the domains of your own workspace. Research looks a domain up.

پارامترها

emailstringالزامی

An address of the sender, such as [email protected].

openemail.WithAPIKeystring

Overrides the client's API key for this call only.

خروجی

An openemail.Object with object set to sender_profile, domain, about and updatedAt.

نمونه

sender, err := client.Senders.Get(ctx, "[email protected]")if err != nil {	return err} fmt.Println(sender.String("domain"), sender.String("about"))

نکته‌ها

همچنین در دسترس در

API
GET /senders/{email}
TypeScript
senders.get()
Python
senders.get()
Ruby
senders.get
PHP
senders->get
Java
senders().get
C#
Senders.GetAsync
CLI
openemail senders get

Senders.Research

Look a sender up

محدوده‌های دسترسیthreads:read
امضای متد
Research(ctx context.Context, email string, opts ...openemail.RequestOption) (openemail.Object, error)

Searches the web for the organisation behind the domain of an address and keeps what it found, as the reading pane does the first time it shows a sender. Every address under the domain shares the answer, a subdomain such as mail.stripe.com included, and it is kept for 30 days before it is looked up again, so a domain that was looked up before is answered from what was kept and nothing is searched. Personal mailbox providers such as Gmail and the domains of your own workspace are never looked up.

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 new domains a day, and the next one is a 429 research_limit_reached. A domain nothing could be found about, a personal mailbox provider and a domain of your own workspace are a 404.

پارامترها

emailstringالزامی

An address of the sender. Only its domain is looked up.

openemail.WithAPIKeystring

Overrides the client's API key for this call only.

خروجی

An openemail.Object, what was found or what was already known.

نمونه

sender, err := client.Senders.Research(ctx, "[email protected]")if err != nil {	return err} fmt.Println(sender.String("about"))

نکته‌ها

  • The SDK retries it after a network failure, which is safe because a domain that was found is answered from what was kept.

همچنین در دسترس در

API
POST /senders/{email}/research
TypeScript
senders.research()
Python
senders.research()
Ruby
senders.research
PHP
senders->research
Java
senders().research
C#
Senders.ResearchAsync
CLI
openemail senders research