### Query Documentation Source: https://docs.mailtrap.io/guides/integrations/cpanel Example of how to query the documentation dynamically using an HTTP GET request with an 'ask' query parameter. ```http GET https://docs.mailtrap.io/guides/integrations/cpanel.md?ask= ``` -------------------------------- ### Install Go Mailtrap SDK Source: https://docs.mailtrap.io/getting-started/email-api-smtp.md Install the official Mailtrap SDK for Go using go get. ```bash go get github.com/railsware/mailtrap-go ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://docs.mailtrap.io/account-and-organization/management/sso/azure-microsoft-entra Perform an HTTP GET request to query the documentation dynamically. Include your specific question in the `ask` query parameter. ```http GET https://docs.mailtrap.io/account-and-organization/management/sso/azure-microsoft-entra.md?ask= ``` -------------------------------- ### API Query Example Source: https://docs.mailtrap.io/email-marketing/contacts/lists Query documentation dynamically by performing an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page. ```http GET https://docs.mailtrap.io/email-marketing/contacts/lists.md?ask= ``` -------------------------------- ### Install Mailtrap CLI with Go Source: https://docs.mailtrap.io/email-api-smtp/advanced/mailtrap-cli-app Install the Mailtrap CLI using the Go programming language's installation command. ```bash go install github.com/mailtrap/mailtrap-cli@latest ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/digitalocean Perform an HTTP GET request to the current page URL with the `ask` query parameter to get specific answers or related documentation. ```bash GET https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/digitalocean.md?ask= ``` -------------------------------- ### Querying Documentation with GET Request Source: https://docs.mailtrap.io/guides/integrations/retool/retool-openapi-integration Use this GET request to query the documentation index for specific information. Append your question to the 'ask' parameter. ```http GET https://docs.mailtrap.io/guides/integrations/retool/openapi.md?ask= ``` -------------------------------- ### Install Mailtrap Python SDK Source: https://docs.mailtrap.io/guides/sdk/python-integration Install the Mailtrap Python SDK using pip. This is the first step to using the SDK for sending emails. ```bash pip install mailtrap ``` -------------------------------- ### Retool GET Request for Dynamic Documentation Querying Source: https://docs.mailtrap.io/guides/integrations/retool/rest-api Use this GET request format to query the documentation dynamically. Replace `` with your specific query. ```http GET https://docs.mailtrap.io/guides/integrations/retool/rest-api.md?ask= ``` -------------------------------- ### Get Sandbox Messages via PHP SDK Source: https://docs.mailtrap.io/email-sandbox/overview.md Retrieve sandbox messages using the Mailtrap PHP SDK. This example demonstrates how to fetch messages from a specific inbox. Ensure you have the Mailtrap SDK installed. ```php use Mailtrap\MailtrapClient; use Mailtrap\Helper\ResponseHelper; $mailtrap = new MailtrapClient('YOUR_API_TOKEN'); // Get sandbox messages $response = $mailtrap ->sandbox() ->inbox(INBOX_ID) ->messages() ->get(); ``` -------------------------------- ### Install Dependencies Source: https://docs.mailtrap.io/guides/sdk/elixir-integration After adding the SDK to your dependencies, run this command in the terminal to fetch them. ```bash mix deps.get ``` -------------------------------- ### Install Mailtrap Node Manually Source: https://docs.mailtrap.io/guides/integrations/n8n Use npm to install the Mailtrap node for local N8N setups. Ensure you have Node.js and npm installed. ```bash npm install n8n-nodes-mailtrap ``` -------------------------------- ### Mailtrap API GET Request Example Source: https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/sending-from-domain-not-allowed Use this GET request to query Mailtrap documentation dynamically. Replace `` with your specific query. ```http GET https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/sending-from-domain-not-allowed.md?ask= ``` -------------------------------- ### Query Documentation with Qodo Agent Source: https://docs.mailtrap.io/guides/ai-powered-integrations/qodo Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. ```bash GET https://docs.mailtrap.io/guides/ai-powered-integrations/qodo.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/email-api-smtp/deliverability/protecting-domain-security Perform an HTTP GET request to query the documentation dynamically. Include your question in the `ask` query parameter for a direct answer and relevant excerpts. ```http GET https://docs.mailtrap.io/email-api-smtp/deliverability/protecting-domain-security.md?ask= ``` -------------------------------- ### Prompt Cursor AI for Mailtrap Integration Source: https://docs.mailtrap.io/guides/ai-powered-integrations/cursor This is an example prompt to guide Cursor AI in integrating Mailtrap into your project. It specifies using the Mailtrap API, providing credentials, and securely storing them in a .env file. ```plaintext Integrate Mailtrap into my project, so that it can send emails through the Mailtrap email API. For this, use my Mailtrap API token and sending address. Make sure to safely store my credentials in an .env file ``` -------------------------------- ### Querying Documentation Dynamically Source: https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/ssl-cipher-overlap-error Use this method to ask questions about the documentation. Replace `` with your specific query. ```http GET https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/ssl-cipher-overlap-error.md?ask= ``` -------------------------------- ### Query Documentation via API Source: https://docs.mailtrap.io/email-sandbox/setup Use this GET request format to query the documentation dynamically with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://docs.mailtrap.io/email-sandbox/setup.md?ask= ``` -------------------------------- ### Query Documentation via GET Request Source: https://docs.mailtrap.io/email-api-smtp/setup/smtp-integration To get additional information not directly present on the page, make a GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://docs.mailtrap.io/email-api-smtp/setup/smtp-integration.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/aws-route-53 Perform an HTTP GET request to the current page URL, including the `ask` query parameter with your question. The response will contain a direct answer and relevant documentation excerpts. ```http GET https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/aws-route-53.md?ask= ``` -------------------------------- ### Querying Documentation Dynamically Source: https://docs.mailtrap.io/developers/email-sending/transactional Perform an HTTP GET request to query documentation dynamically. Use the 'ask' query parameter with a specific question. ```bash GET https://docs.mailtrap.io/developers/email-sending/transactional.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/google-cloud-dns Perform an HTTP GET request to the current page URL with the `ask` query parameter to get specific information. The question should be self-contained and in natural language. ```bash GET https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/google-cloud-dns.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.mailtrap.io/email-sandbox/collaboration Perform an HTTP GET request to the current page URL with the `ask` query parameter to get direct answers and relevant excerpts from the documentation. Use this when information is not explicitly present or for clarification. ```HTTP GET https://docs.mailtrap.io/email-sandbox/collaboration.md?ask= ``` -------------------------------- ### Install Mailtrap Gem Source: https://docs.mailtrap.io/guides/sdk/ruby-integration After adding the gem to your Gemfile, run this command in your terminal to install it. ```bash bundle install ``` -------------------------------- ### Click Event Example Source: https://docs.mailtrap.io/email-api-smtp/advanced/webhooks Example of a click event payload received via webhook. ```APIDOC ## Click Event ### Description Indicates that a recipient has clicked on a link within an email. ### Event Type `click` ### Fields * **event** (string) - `click` * **timestamp** (integer) - Unix epoch timestamp. * **message_id** (string) - The unique identifier for the message. * **email** (string) - The recipient's email address. * **event_id** (string) - A unique identifier for this specific event. * **sending_stream** (string) - The sending stream used (e.g., `transactional`). * **url** (string) - The URL that was clicked. * **sending_domain_name** (string) - The sending domain used. ### Example ```jsonl {"event":"click","timestamp":1728669935,"message_id":"abc-123","email":"user1@example.com","event_id":"evt-3","sending_stream":"transactional","url":"https://example.com","sending_domain_name":"example.com"} ``` ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.mailtrap.io/developers/email-sending/email-logs Perform an HTTP GET request on the current page URL with the `ask` query parameter to get specific information not explicitly present or to retrieve related documentation sections. ```bash GET https://docs.mailtrap.io/developers/email-sending/email-logs.md?ask= ``` -------------------------------- ### Open Event Example Source: https://docs.mailtrap.io/email-api-smtp/advanced/webhooks Example of an open event payload received via webhook. ```APIDOC ## Open Event ### Description Indicates that a recipient has opened an email. ### Event Type `open` ### Fields * **event** (string) - `open` * **timestamp** (integer) - Unix epoch timestamp. * **message_id** (string) - The unique identifier for the message. * **email** (string) - The recipient's email address. * **event_id** (string) - A unique identifier for this specific event. * **sending_stream** (string) - The sending stream used (e.g., `transactional`). * **ip** (string, optional) - The IP address from which the email was opened. * **sending_domain_name** (string) - The sending domain used. ### Example ```jsonl {"event":"open","timestamp":1728669930,"message_id":"abc-123","email":"user1@example.com","event_id":"evt-2","sending_stream":"transactional","ip":"192.168.1.1","sending_domain_name":"example.com"} ``` ``` -------------------------------- ### Bounce Event Example Source: https://docs.mailtrap.io/email-api-smtp/advanced/webhooks Example of a bounce event payload received via webhook. ```APIDOC ## Bounce Event ### Description Indicates that an email could not be delivered due to a permanent failure. ### Event Type `bounce` ### Fields * **event** (string) - `bounce` * **timestamp** (integer) - Unix epoch timestamp. * **sending_stream** (string) - The sending stream used (e.g., `transactional`). * **message_id** (string) - The unique identifier for the message. * **email** (string) - The recipient's email address. * **event_id** (string) - A unique identifier for this specific event. * **response** (string) - The reason for the bounce. * **response_code** (integer) - The SMTP response code. * **bounce_category** (string) - The category of the bounce (e.g., `spam`). * **sending_domain_name** (string) - The sending domain used. ### Example ```jsonl {"event":"bounce","timestamp":1728669927,"sending_stream":"transactional","message_id":"1df37d17-0286-4d8b-8edf-bc4ec5be86e6","email":"receiver@example.com","event_id":"bede7236-2284-43d6-a953-1fdcafd0fdbc","response":"[CS01] Message rejected","response_code":555,"bounce_category":"spam","sending_domain_name":"examplesender.com"} ``` ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://docs.mailtrap.io/developers/email-sending/bulk Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask specific questions. The response will contain a direct answer and relevant excerpts. ```http GET https://docs.mailtrap.io/developers/email-sending/bulk.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.mailtrap.io/developers/email-sandbox/send-test-emails Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information. The question should be specific, self-contained, and written in natural language. ```bash GET https://docs.mailtrap.io/developers/email-sandbox/send-test-emails.md?ask= ``` -------------------------------- ### Delivery Event Example Source: https://docs.mailtrap.io/email-api-smtp/advanced/webhooks Example of a delivery event payload received via webhook. ```APIDOC ## Delivery Event ### Description Indicates that an email was successfully delivered to the recipient's mail server. ### Event Type `delivery` ### Fields * **event** (string) - `delivery` * **timestamp** (integer) - Unix epoch timestamp. * **sending_stream** (string) - The sending stream used (e.g., `transactional`). * **category** (string) - The category assigned to the email. * **message_id** (string) - The unique identifier for the message. * **email** (string) - The recipient's email address. * **event_id** (string) - A unique identifier for this specific event. * **sending_domain_name** (string) - The sending domain used. ### Example ```jsonl {"event":"delivery","timestamp":1728669927,"sending_stream":"transactional","category":"Password reset","message_id":"1df37d17-0286-4d8b-8edf-bc4ec5be86e6","email":"receiver@example.com","event_id":"bede7236-2284-43d6-a953-1fdcafd0fdbc","sending_domain_name":"examplesender.com"} ``` ``` -------------------------------- ### Dynamic Documentation Query Source: https://docs.mailtrap.io/account-and-organization/management/users Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, natural language question. The response includes direct answers and relevant excerpts. ```HTTP GET https://docs.mailtrap.io/account-and-organization/management/users.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/ms-office-365-quarantine Perform an HTTP GET request to the current page URL with the `ask` query parameter to get additional information not directly present on the page. The question should be specific and self-contained. ```http GET https://docs.mailtrap.io/email-api-smtp/help/troubleshooting/ms-office-365-quarantine.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/squarespace Use this method to ask specific questions about the documentation. The response includes direct answers and relevant excerpts. ```http GET https://docs.mailtrap.io/email-api-smtp/setup/sending-domain/squarespace.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.mailtrap.io/developers/email-sending/stats To get information not explicitly present on the page, make an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language. ```HTTP GET https://docs.mailtrap.io/developers/email-sending/stats.md?ask= ```