Get the list of mail services mailservice.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: mailservice

Who can execute the method: any user

The method mailservice.list returns a list of active mail services.

Method Parameters

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/mailservice.list
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth": "**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/mailservice.list
        
// 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 each mail service item returned in result[]
        type MailServiceItem = {
          ID: string
          SITE_ID: string
          ACTIVE: string
          SORT: string
          NAME: string
          SERVER: string
          PORT: string
          ENCRYPTION: string
          LINK: string
          ICON: string
          SMTP_SERVER: string | null
          SMTP_PORT: string | null
          SMTP_LOGIN_AS_IMAP: string
          SMTP_PASSWORD_AS_IMAP: string
          SMTP_ENCRYPTION: string | null
          UPLOAD_OUTGOING: string | null
        }
        
        try {
          // mailservice.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<MailServiceItem[]>({
            method: 'mailservice.list',
            params: {
              start: 0,
            },
            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('Mail services:', result.length, result)
          }
        } 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 listMailServices() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // mailservice.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'mailservice.list',
                params: {
                  start: 0,
                },
                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('Mail services:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listMailServices)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.mailservice.list().response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call('mailservice.list', []);
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'mailservice.list',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call('mailservice.list', []);
        print_r($result);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "mailservice.list", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("mailservice.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "1",
                    "SITE_ID": "s1",
                    "ACTIVE": "Y",
                    "SORT": "100",
                    "NAME": "gmail",
                    "SERVER": "imap.gmail.com",
                    "PORT": "993",
                    "ENCRYPTION": "Y",
                    "LINK": "https://mail.google.com/",
                    "ICON": "https://cdn.com.bitrix24.com/b17053/mail/mailservices/icon/ac0/ac08d334f35100d98c1a628f4f57f25c/post_gmail_icon.png",
                    "SMTP_SERVER": "smtp.gmail.com",
                    "SMTP_PORT": "465",
                    "SMTP_LOGIN_AS_IMAP": "Y",
                    "SMTP_PASSWORD_AS_IMAP": "Y",
                    "SMTP_ENCRYPTION": "Y",
                    "UPLOAD_OUTGOING": "N"
                },
                ... // description for each mail service
            ],
            "time": {
                "start": 1774009798,
                "finish": 1774009798.248488,
                "duration": 0.2484879493713379,
                "processing": 0,
                "date_start": "2026-03-20T15:29:58+02:00",
                "date_finish": "2026-03-20T15:29:58+02:00",
                "operating_reset_at": 1774010398,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object[]

Array of objects with information about mail services.

The structure of the mail service object is described in detail below

time
time

Information about the request execution time

Mailservice Object

Name
type

Description

ID
integer

Identifier of the mail service

SITE_ID
string

Identifier of the site in Bitrix24

ACTIVE
string

Service activity, values Y or N

SORT
integer

Sort index

NAME
string

Name of the service

SERVER
string

IMAP server address in lowercase

PORT
integer

IMAP server port

ENCRYPTION
string

Indicator of secure connection, values Y or N

LINK
string

Address of the service's web interface

ICON
string

Path to the service's logo image

SMTP_SERVER
string|null

SMTP server, if configured

SMTP_PORT
integer|null

SMTP port, if configured

SMTP_LOGIN_AS_IMAP
string

Use IMAP login for SMTP, values Y or N

SMTP_PASSWORD_AS_IMAP
string

Use IMAP password for SMTP, values Y or N

SMTP_ENCRYPTION
string|null

Indicator of secure SMTP connection, values Y or N

UPLOAD_OUTGOING
string|null

Indicator of uploading outgoing e-mails, values Y or N

Error Handling

HTTP status: 400

{
            "error": "ERROR_CORE",
            "error_description": "No mail services found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

ERROR_CORE

No mail services found

No active mail services

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning