Belgelere geç
PHP

$client->languages

Bu ad alanındaki her yöntem: imzası, parametreleri, döndürdüğü değer ve bir örnek.

Yöntemler

Every language a translated send or preview accepts. The package also ships a copy of the table as OpenEmail\Constants\Languages::ALL.

languages->list

List every language a message can be sent in

Kapsam yok
İmza
list(?string $apiKey = null): array

Returns the whole language table in one response, with no cursor. It sits behind a key like every other endpoint but needs no scope, because it names no data belonging to anybody. The table is around two hundred rows and changes a handful of times a year, so fetch it once and keep it.

The order is meaningful. The languages people are most likely to be emailed in come first, then regional variants, then the rest by region. A picker should render the rows in the order they arrive until somebody types, then search native, label and code together. Show native first, since it is the word someone looking for their own language is scanning for, and never show flag on its own: a flag names a country, not a language.

Any row's code, label or native is accepted by translate.to on emails->send and by emails->translate. The package also ships the same table as OpenEmail\Constants\Languages::ALL, with OpenEmail::resolveLanguage to find a row by any of those names, which is useful before the first request, while this call returns the server's current rows.

Parametreler

apiKeystring

Authenticates this call with a different key.

Döndürür

A list of arrays, each with code (BCP-47), label (English name), native (endonym), flag and rtl.

Örnek

$languages = $client->languages->list(); foreach ($languages as $language) {    echo $language['native'], ' (', $language['code'], ')', $language['rtl'] ? ' right to left' : '', PHP_EOL;}

Notlar

  • rtl marks right-to-left targets. A translated body for one of them is wrapped in dir="rtl" before it is sent.

  • The bundled Languages::ALL table can lag the server by however old your installed package is, so prefer this call when a newly added language matters.

Şurada da var

API
GET /languages
TypeScript
languages.list()
Python
languages.list()
Ruby
languages.list
CLI
openemail languages list