# Email Query

{% hint style="info" %}
💬 **Need help?** If you're stuck, ask Eva on ATRIP for instant diagnostics.

<a href="https://www.atriptech.com/" class="button primary" data-icon="comments">Ask Eva</a>
{% endhint %}

Use `Email Query` as the primary name in guides and links.

This API maps to `queryMail.do`.

Legacy materials may call it `Email List`.

## Email List

> \*\*Dependency\*\*\
> No preceding function needs to be carried out.\
> \
> \*\*Endpoint:\*\*\
> <https://sandbox.atriptech.com/queryMail.do>

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Other Functions"}],"security":[],"paths":{"/queryMail.do":{"post":{"summary":"Email List","deprecated":false,"description":"**Dependency**\nNo preceding function needs to be carried out.\n\n**Endpoint:**\nhttps://sandbox.atriptech.com/queryMail.do","tags":["Other Functions"],"parameters":[{"name":"Accept","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"x-atlas-client-id","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"x-atlas-client-secret","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orderNo":{"type":"string","description":"Order number.\nAt least one of the order number, receiving time and/or creation time must be specified for querying.","nullable":true},"emailReceivingDateStart":{"type":"string","description":"Start of the receiving time.\nThe time Atlas received the airline's email.\nFormat: yyyy-MM-dd hh:mm:ss UTC+08:00","nullable":true},"emailReceivingDateEnd":{"type":"string","description":"End of the receiving time.\nThe time Atlas received the airline's email.\nFormat: yyyy-mm-dd hh:mm:ss UTC+08:00.\nYou can only query data for up to one month at a time","nullable":true},"createTimeStart":{"type":"string","description":"Start of creation time.\nCreate Time is the time when Atlas created this email record in the Email list. Generally, it will be later than the receiving time.\nFormat: yyyy-mm-dd hh:mm:ss UTC+08:00","nullable":true},"createTimeEnd":{"type":"string","description":"End of creation time.\nCreate Time is the time when Atlas created this email record in the Email list. Generally, it will be later than the receiving time.\nFormat: yyyy-MM-dd hh:mm:ss UTC+08:00\nYou can only query data for up to one month at a time.","nullable":true},"emailCategories":{"type":"string","description":"Atlas email categories. Atlas categorizes emails but does not guarantee accuracy in classification.\n-`Travel Itinerary`\n-`Schedule Change`\n-`Payment Due`\n-`Payment Success`\n-`Receipt`\n-`Trip Reminder`\n-`PNR Cancellation Success`\n-`Advertisement`\n-`Duplicated Schedule Change`\n-`Verification`\n-`Unaccounted Cancellation`\n-`Promo code`","nullable":true},"pageIndex":{"type":"string","default":"1","nullable":true},"pageSize":{"type":"string","default":"100","nullable":true}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"msg":{"type":"string","nullable":true},"hasNext":{"type":"boolean","description":"-`true`: There is also the next page\n-`false`: There is not the next page"},"records":{"type":"array","items":{"type":"object","properties":{"orderNo":{"type":"string","description":"Order number"},"emailReceivingDate":{"type":"string","description":"The time Atlas received the airline's email.\nFormat: yyyy-MM-dd HH:mm:ss UTC+08:00"},"uniqueCode":{"type":"string","description":"Unique Code of the email"},"emailCategory":{"type":"string","description":"Atlas email categories. Atlas categorizes emails but does not guarantee accuracy in classification."},"from":{"type":"string","description":"Email “from” address"},"to":{"type":"string","description":"Email “to” address"},"emailSubject":{"type":"string","description":"Email “Subject”"},"emailLink":{"type":"string","description":"Email Link. Email Link is only valid for 10 mins.","nullable":true},"createTime":{"type":"string","description":"Create Time is the time when Atlas created this email record in the Email list.\nGenerally, it will be later than the receiving time.\nFormat: yyyy-MM-dd HH:mm:ss UTC+08:00"}},"required":["orderNo","emailReceivingDate","uniqueCode","emailCategory","from","to","emailSubject","createTime"]}}},"required":["status","hasNext","records"]}}},"headers":{}}}}}}}
```