MailerGetProviderAdapters¶

GET mailer/providers/adapters

Returns the adapters the running module actually has, with the capabilities of each and the credential fields it expects.

This is the source of truth for provider setup: the matrix comes from the code, so it cannot drift from reality. Use it to build the provider form and to decide which deliveryUpdateBy mode a profile may use.

Access Control¶

Allowed roles: admin, provider.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/providers/adapters
Authorization: <JWT_TOKEN>

{
  "command": "MailerGetProviderAdapters",
  "extID": "1",
  "data": {}
}

const res = await platform.MailerGetProviderAdapters({});

Request Data¶

This method takes no parameters.

Response Data¶

A ? suffix marks an optional credential. domainCheck says whether MailerVerifyProfileDomain can ask this provider about DKIM and SPF; without it the check has to be done by hand in the provider panel.

{
  "rows": [
    {
      "name": "postmark",
      "title": "Postmark",
      "capabilities": {
        "sendEmail": true,
        "statusRequest": true,
        "webhook": true,
        "balance": false,
        "domainCheck": true
      },
      "credentialsSchema": {
        "serverToken": "string",
        "accountToken": "string?",
        "messageStream": "string?"
      }
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Session may not read the provider catalogue