Get AKMTA sender information

Description

Retrieves AKMTA sender detailed information.

Request URL

Method: POST

https://example.com/api/v1.1/admin/senders/get/

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	10	Yes	Sender ID
format	string	"json"	No	Response data format By default – json

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 1
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>1</id>
</xml>

Response example

JSON

{
    "data": {
        "akmta_obj": {
            "dkim_id": 1,
            "dkim_selector": "abcdefghijklmnqrstuvwxyz",
            "ips": [
                {
                    "ip": "10.200.1.93",
                    "node": 1
                },
                {
                    "ip": "10.200.1.94",
                    "node": 1
                }
            ],
            "lock_rules_obj": {
                "common_rules": [],
                "isp_rules": []
            },
            "relay_options": {
                "enable_relay": "on",
                "host": "relay.example.com",
                "port": 587,
                "type": "login",
                "auth": {
                    "user": "relayuser"
                },
                "start_tls": true,
                "strategy_id": 7
            },
            "redirect_email": "",
            "retry_rules_obj": {
                "common_rules": [],
                "isp_rules": []
            },
            "sender_dkim_id": 1,
            "sender_dkim_selector": "abcdefghijklmnqrstuvwxyz",
            "sending_rules_obj": {
                "common_rules": [
                    {
                        "isps": [
                            0
                        ],
                        "strategy": 7
                    }
                ],
                "ip_rules": []
            },
            "users": []
        },
        "assigned_accounts": [
            1
        ],
        "channel_type": "email",
        "id": 3,
        "name": "Email sender",
        "type": "akmta",
        "verified_domains": [],
        "verified_recipients": []
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <akmta_obj>
            <dkim_id>1</dkim_id>
            <dkim_selector>abcdefghijklmnqrstuvwxyz</dkim_selector>
            <ips>
                <ip>10.200.1.93</ip>
                <node>1</node>
            </ips>
            <ips>
                <ip>10.200.1.94</ip>
                <node>1</node>
            </ips>
            <lock_rules_obj>
                <common_rules/>
                <isp_rules/>
            </lock_rules_obj>
            <relay_options>
                <enable_relay>on</enable_relay>
                <host>relay.example.com</host>
                <port>587</port>
                <type>login</type>
                <auth>
                    <user>relayuser</user>
                </auth>
                <start_tls>true</start_tls>
                <strategy_id>7</strategy_id>
            </relay_options>
            <redirect_email/>
            <retry_rules_obj>
                <common_rules/>
                <isp_rules/>
            </retry_rules_obj>
            <sender_dkim_id>1</sender_dkim_id>
            <sender_dkim_selector>abcdefghijklmnqrstuvwxyz</sender_dkim_selector>
            <sending_rules_obj>
                <common_rules>
                    <isps>0</isps>
                    <strategy>7</strategy>
                </common_rules>
                <ip_rules/>
            </sending_rules_obj>
            <users/>
        </akmta_obj>
        <assigned_accounts>1</assigned_accounts>
        <channel_type>email</channel_type>
        <id>3</id>
        <name>Email sender</name>
        <type>akmta</type>
        <verified_domains/>
        <verified_recipients/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Sender ID
name	string	Sender name
type	string	Sender type
channel_type	string	Communication channel type
assigned_accounts	JSON array	Accounts assigned to the sender
verified_domains	JSON array	Verified email domains
akmta_obj	JSON object	AKMTA object
akmta_obj.relay_options	JSON object	SMTP relay settings (enable_relay: "on" if the relay is enabled, "off" — if disabled)
akmta_obj.relay_options.host	string	Relay network address
akmta_obj.relay_options.port	int	Relay port
akmta_obj.relay_options.type	string	Authentication method: noAuth, login, plain, cram-md5
akmta_obj.relay_options.auth	JSON object	Authentication credentials: user (always returned), password (not returned)
akmta_obj.relay_options.start_tls	bool	Whether Start TLS is enabled
akmta_obj.relay_options.strategy_id	int	Sending strategy ID (optional; required in the web interface when the relay is enabled)