> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/panel-api/resources/gateways.md). # Gateways ## Email gateway object A dealer can send notification mail either through a gateway it owns, or through one leased from the platform owner. The two are separate objects, and the list operation returns them separately. Own gateways currently support the SMTP provider only. Leased gateways are not limited to SMTP: `router` and `mandrill_smtp` have both been observed. ## The DealerOwnEmailGateway object ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"components":{"schemas":{"DealerOwnEmailGateway":{"type":"object","description":"An email gateway owned by the dealer. Only the SMTP provider is currently supported.","readOnly":true,"properties":{"id":{"type":"integer","description":"Gateway ID."},"leasable":{"type":"boolean","description":"Whether this dealer offers the gateway for lease to sub-dealers."},"label":{"type":"string","description":"Display label."},"provider":{"type":"string","description":"Gateway provider. Own gateways currently support `smtp` only."},"params":{"type":"object","description":"Provider-specific configuration. For SMTP this carries `default_from_address` plus the `mail.smtp.*` transport settings. Contents vary by provider, so the shape is not fixed.","additionalProperties":true}}}}}} ``` ## The LeasableEmailGateway object ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"components":{"schemas":{"LeasableEmailGateway":{"type":"object","description":"An email gateway offered for lease by the platform owner.","readOnly":true,"properties":{"id":{"type":"integer","description":"Gateway ID."},"label":{"type":"string","description":"Display label."},"provider":{"type":"string","description":"Gateway provider. Values observed include `router` and `mandrill_smtp`, so this is not limited to `smtp`."},"default_from_address":{"type":"string","description":"Address mail from this gateway is sent from."}}}}}} ``` For an SMTP gateway, `params` carries `default_from_address` together with the `mail.smtp.*` transport settings, for example `mail.smtp.host`, `mail.smtp.port`, `mail.smtp.auth`, and the TLS options. The exact set depends on the provider. ## API actions API path: `panel/gateways/email`. *** *required permissions*: `email_gateways: "read"`. ## List email gateways > List the email gateways available to the current dealer, and report which one is currently bound.\ > \ > The response separates gateways the dealer owns from gateways that can be leased from the platform owner. Takes no parameters beyond the session credential.\ > \ > A dealer that \*is\* the platform owner receives an empty \`leasable\` list, since there is nobody to lease from. ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Gateways","description":"Email gateways a dealer can send notification mail through, either owned by the dealer or leased from the platform owner. All resources under the /panel/gateways/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"DealerOwnEmailGateway":{"type":"object","description":"An email gateway owned by the dealer. Only the SMTP provider is currently supported.","readOnly":true,"properties":{"id":{"type":"integer","description":"Gateway ID."},"leasable":{"type":"boolean","description":"Whether this dealer offers the gateway for lease to sub-dealers."},"label":{"type":"string","description":"Display label."},"provider":{"type":"string","description":"Gateway provider. Own gateways currently support `smtp` only."},"params":{"type":"object","description":"Provider-specific configuration. For SMTP this carries `default_from_address` plus the `mail.smtp.*` transport settings. Contents vary by provider, so the shape is not fixed.","additionalProperties":true}}},"LeasableEmailGateway":{"type":"object","description":"An email gateway offered for lease by the platform owner.","readOnly":true,"properties":{"id":{"type":"integer","description":"Gateway ID."},"label":{"type":"string","description":"Display label."},"provider":{"type":"string","description":"Gateway provider. Values observed include `router` and `mandrill_smtp`, so this is not limited to `smtp`."},"default_from_address":{"type":"string","description":"Address mail from this gateway is sent from."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/panel/gateways/email/list":{"post":{"tags":["Gateways"],"summary":"List email gateways","operationId":"gatewaysEmailList","description":"List the email gateways available to the current dealer, and report which one is currently bound.\n\nThe response separates gateways the dealer owns from gateways that can be leased from the platform owner. Takes no parameters beyond the session credential.\n\nA dealer that *is* the platform owner receives an empty `leasable` list, since there is nobody to lease from.","responses":{"200":{"description":"Email gateways","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"bound_gateway":{"type":["integer","null"],"description":"ID of the gateway currently bound to this dealer, or `null` when none is bound.","readOnly":true},"own":{"type":"array","description":"Gateways owned by this dealer.","readOnly":true,"items":{"$ref":"#/components/schemas/DealerOwnEmailGateway"}},"leasable":{"type":"array","description":"Gateways offered for lease by the platform owner.","readOnly":true,"items":{"$ref":"#/components/schemas/LeasableEmailGateway"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` A dealer that is itself the platform owner receives an empty `leasable` list. The originators used when sending through the bound gateway are configured in [notification settings](/docs/navixy-api/panel-api/resources/dealer/settings/notification.md). #### Errors [General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types only. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/panel-api/resources/gateways.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.