mail.mailbox.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"email","select":["name","type","title"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/mail.mailbox.field.get

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type MailboxFieldGetResult = {
  item: {
    name?: string
    type?: string
    title?: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<MailboxFieldGetResult>({
    method: 'mail.mailbox.field.get',
    params: {
      name: 'email',
      select: [
        'name',
        'type',
        'title',
      ],
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.item)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getMailboxField() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'mail.mailbox.field.get',
        params: {
          name: 'email',
          select: [
            'name',
            'type',
            'title',
          ],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.item)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getMailboxField)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

select = [
    "name",
    "type",
    "title",
]

try:
    bitrix_response = client.mail.mailbox.field.get(
        name='email',
        select=select,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'mail.mailbox.field.get',
            [
                'name' => 'email',
                'select' => [
                    'name',
                    'type',
                    'title'
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

BX24.callMethod(
    'mail.mailbox.field.get',
    {
        name: 'email',
        select: [
            'name',
            'type',
            'title'
        ]
    },
    function(result) {
        console.info(result.data());
        console.log(result);
    }
);

require_once('crest.php');

$result = CRest::call(
    'mail.mailbox.field.get',
    [
        'name' => 'email',
        'select' => [
            'name',
            'type',
            'title'
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mail.mailbox.field.get", b24.Params{
	"name":   "email",
	"select": []string{"name", "type", "title"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("mail.mailbox.field.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	Name  string `json:"name"`
	Type  string `json:"type"`
	Title string `json:"title"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)