https://learn.emailengine.app/assets/js/171d2e5f.d310a9b4.js

1"use strict";(globalThis.webpackChunkemailengine_temp=globalThis.webpackChunkemailengine_temp||[]).push([[254],{49519(e,t,i){i.r(t),i.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>o,toc:()=>b});const o=JSON.parse('{"id":"api/get-v-1-logs-account","title":"Return stored logs for an account","description":"Output is a downloadable text file with one JSON log entry per line, or a plain-text notice when nothing is stored<br/><br/>Nothing is stored unless logging is enabled for the account, either with the account logs flag or the global logs.all setting. IMAP accounts record the protocol trace, Gmail API and MS Graph accounts record their API requests, and SMTP transactions are recorded for any account that sends over SMTP.","source":"@site/docs/api/get-v-1-logs-account.api.mdx","sourceDirName":"api","slug":"/api/get-v-1-logs-account","permalink":"/docs/api/get-v-1-logs-account","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-v-1-logs-account","title":"Return stored logs for an account","description":"Output is a downloadable text file with one JSON log entry per line, or a plain-text notice when nothing is stored<br/><br/>Nothing is stored unless logging is enabled for the account, either with the account logs flag or the global logs.all setting. IMAP accounts record the protocol trace, Gmail API and MS Graph accounts record their API requests, and SMTP transactions are recorded for any account that sends over SMTP.","sidebar_label":"Return stored logs for an account","hide_title":true,"hide_table_of_contents":true,"api":"eJztWm1v3DYS/isDfkoAeb120rvrXq93brvJ+WA7hu0UOCRBPSvNrthQpEJSa2+N/e+HIamVZG9qF7fBXYF+SdYiOZyXZ140oztharLopdHHhZiIBfkfD07Mwh3luWm0F5koyOVW1rxFTMSbxteNB+kAoTA3WhkscKYIPN16mEtFcCN9CUYT/OvyzRkoswDS3q6gJgtKasrAWECoFUq9F45p42VOcFOS5t+l1Au+wXljqfhmZve/Df+c3V+CRityju9YpAXSzE0Bc2PBlwQY5ciApC/JRuZ6C3zWwVzhAtKJhTIzVOH5CJUCR95LvRjB8enReXvMgaXc2CKcqK3xJjcKvMWcMnhdoVRwdH4MqAs4vYTXFuty21FpwzZLnxpy3mXhwOXp1TmT0g5z1roDtJQOJclQrzYC+BI9ONKFA7MkG46PRCZqtFiRJ+vE5N2d0FiRmIjbPaI9LysyDRtXsk1LwoKsyITLS6pQTO6EX9W8W2pPi7A0RMFFZBgSIZAaKqmUdJQbXbgRXKB05IJ2clNVLFa7F2dmSWFlOj17fXw2/enq+HT65u0VFDTHRvkoISijF3u20ZotmzT0V0BYomoIZqTMTaDSnirRgTZA8znlLBrdYlUrEpMX4/F4nIlKalk1lZjwb7yNv/98yIvj9e9PwHW2sSlufDWYs0ZfbjOm81bqxQNbvtXyU0MgC9JeziXZje9QwHFHfaNR0TiyB4cvRNDkCemFL8Xk8Ks/ZeJ2Lzd6SdaHi62sxMTbhtYPNPz0a1k10lKRKH3IhMcFg1pwoBIfeIerjXbk+NLD8Zj/u29P31jt7ns+oGsjUQxgzlvCit0nN9qTjmLQrd8Pm/ivz+l1vWYhX267/VgvUckCpObYuReDBvoSOh/N4FNDdgVoF01FmmOBsS0qoMYVB1ooZMEBEmp0DgLNELpHcKScARuEpCIG0k6VjiwHBkvzxlEMWYlwxsC+KWVeQo6O0lJUJuRorSRWUG4KCqGJ1zfU0japnScswMwBYS5JFaCk80MVYl0rmQdm9392Zrsizezn6LpD7f24kRPIWsPRqLactryMFncefeO+NwU9IXT98+rqHOKJIFcf1y9DJIiXPOo3fUKMkIGDfIcFpBgi1pmoyDlc0ONEp3w3tNv7FAcYYppB1a5HEq3F1QOKJ9J5tk3EXjwUc8YcJWfKDkYcQDxVbptJhhp/sjw/dH8xE4yf7r7AQWOHcr4XNS7oUv5C7wVUjfMwIwhZ3peo2SnoU4MKvIGD8XjMmvhIq8c5OcOKWhZ6uvi8KjqWWob4rhBcH73sVaNU9PAn3ziCS+YQHXykVcoQ3tR7ipak4skMCuN9WwKAJsd/GD1UoDej8QiLwpJzgkOSlz4sdH4UUPaKSYpH1h1vyIee9RmZTzEvpaY9S6kiDH4UfCwDOQdcolS8MOD2FKWamdsz41+ZRgd+CvIolXv8xqOikPwTVbornRxeN4Krh5Ewxa6oyDYwVpEX2JTEzI3Uc/M/YCU6WJ+Vz1vqItHYpKCDhynoqPElZ9q88zwqUirCPA/+ZT6S5hq6ks5JveDkEPAZUtFNqD582Fx7KnYX3++x9sVj/MGOYvxbjY0vjZW/ULGjIH8aNQ84UMnA9kNtbbf/iy32jzYuSMvtdi8MRQMvLGrPL2sBBoyVUJdJ14ERnsUzLjc1Zd07lrFwfA4p9jC0vZXhFeb5DtEyEOSLg+XFjsDyytiZLArSO0JKH3zRDkw4lXVUXIYnj9LncBQOBzx09tVEBRVZV0jewwiXhiuQQxGxli0PXK6fbxD0ND56iIsQfBJL3SkHhQnMSZ2rpqD77CUtusmNlT5pqzKejlKqfBKTuZKkfQ/lDxiSHfC51jZgQt8hbSc34Olw/GI0Hh0cvBgdDJ08gPyHgPHtLv7yoYufGX6zbHTr3hswcP9F+hU82zhq0kXWprwMyOej552B6XanJXzH2hd32Jc7clhmeVOS7MBhLzbWaHN7m1Hn7S3/dZ01zCXxmq6y6uGrfbgVW4dfb3l/Rk+gZCUZGnlwRUaZMVBxL6ptYMENWYIKC2obbdwo7KWZ3UGqz9EXxtTh1zvC1JUxcMr6SmBwu8LWQ+uEwt6rJ4h+GVta0GgvVQwcHbkbqQtzwxGNvBs21fp4YgZO+MA2QH21vSXiyXK5nOrgCOI9QA2NptuaQviMT02eN9aGvgb3l2trGFBcJ/XC3O6QtZW1Lwevr3bWdNgwfhkZD8bYEcSONMitJmuN86VfFFvhNkLt+DVxEB8Hlw3gvM5iC31GJS4lm+yd+GMu8fS5xIekv0hCTASjQKSHC2uaWkwEyxiM70mH0i5MMEKb5572MxG65X9Y4TdagacHPX0ma2y0Ga1yb1O0TrcnWInb8RX50qTpoWhbZGJ/ebDPW/bvEi9rHkqE0BHt2VjFwyfvazfZ3w9dEdILqWmUvH6Um+qBN//bNBamvHkaNrfR6JmlWmGeCo8V78LcN124entx8jyw6y

1hvrPSrwMSM0JLll2oxefehv3zJ6SLG+v6mTbRhxtsxC/8dN4ks/XhlbIWes0yNnxp6GGo5xLR89gqkdb/nlMJRX9yj82O2Adn4ZiUOR385HI1T9sM8ZL80F+ofu2zq2lg2z1DtitDqUV/5WNf7hcndvtscCcscYOOTf9zbztFYyZw4Rm6//SSt3r+9T6ig5f7J8ffTs8vpT9PTo+OTODwb+VsvHkyP+sRra5ayCIOKi+nl1byJ3sWeUKHG4PuDmZLLgkfw8/alMPpWr7KIBwr0CJhb4xxUjfKyVpv7rBu91+/1dMljm3ZQw2+pjouYvk2zMK/hciZGGQw7ro/SC3yoUibwXYANfBOOfHsNcSobZuUarv8eCf4UVv92fW9aNIIrfh5jgXSuoSIIZGlpPoYecQhFqXeS9tahwRj70319YlHJlO3nmFOQsi1YARfIA584CeKG9UCz4f6kRe5L8CntJSq14lfhj0Q1SO9CBcODU+2k45ItA2fASVYxajJcJaFSLtiQvyRoyX9qqCFoaphRKfltEvMyvmCP4KQ/Tt30DZiS5hHCQi5JQ2U4WBpTdaH+uj8Sb9WePZj4drZOU4s0bnOdKsL3DqSXpExNE+7QNxVZmcN1VyxeZ4DgSmM9XIdq5BoUzkgFcyGUTYW6q4yuEz6vRzBlUUkXtZGxN2JpzsIUJo8DQzBardIwr1dqOpA+6CCyG+654aTgS1pBRaiDaGFi0dJKiPz1GBGmIcb5CnXP6+Ogtc3AMX1GCOP2L0ruurL9j49LfiflQ9bmwN5kfJ1i+13K/+/E8kBkbSk3aa3/IROlcZ7X7+5m6OitVes1Pw4RjZMwVxhWhpqcM3QhXdC6mMxROfoV+Dy7SK3H5/D0rwu2StJOVPWqV++INGncfG+x/rDO2o9nfhun//+fl3xGMb1ysPuIaKOgrmA8ClOi3lqfTL9kfD29Euv1fwBj7JLF","sidebar_class_name":"get api-method","info_path":"docs/api/emailengine-api","custom_edit_url":null,"hide_send_button":true},"sidebar":"apiSidebar","previous":{"title":"Flush templates","permalink":"/docs/api/delete-v-1-templates-account-account"},"next":{"title":"Return server stats","permalink":"/docs/api/get-v-1-stats"}}');var r=i(74848),s=i(28453),a=i(57742),n=i.n(a),c=i(78178),l=i.n(c),d=i(19624),p=i.n(d),h=i(96226),u=i.n(h),m=(i(77675),i(19365),i(51107));const g={id:"get-v-1-logs-account",title:"Return stored logs for an account",description:"Output is a downloadable text file with one JSON log entry per line, or a plain-text notice when nothing is stored<br/><br/>Nothing is stored unless logging is enabled for the account, either with the account logs flag or the global logs.all setting. IMAP accounts record the protocol trace, Gmail API and MS Graph accounts record their API requests, and SMTP transactions are recorded for any account that sends over SMTP.",sidebar_label:"Return stored logs for an account",hide_title:!0,hide_table_of_contents:!0,api:"eJztWm1v3DYS/isDfkoAeb120rvrXq93brvJ+WA7hu0UOCRBPSvNrthQpEJSa2+N/e+HIamVZG9qF7fBXYF+SdYiOZyXZ140oztharLopdHHhZiIBfkfD07Mwh3luWm0F5koyOVW1rxFTMSbxteNB+kAoTA3WhkscKYIPN16mEtFcCN9CUYT/OvyzRkoswDS3q6gJgtKasrAWECoFUq9F45p42VOcFOS5t+l1Au+wXljqfhmZve/Df+c3V+CRityju9YpAXSzE0Bc2PBlwQY5ciApC/JRuZ6C3zWwVzhAtKJhTIzVOH5CJUCR95LvRjB8enReXvMgaXc2CKcqK3xJjcKvMWcMnhdoVRwdH4MqAs4vYTXFuty21FpwzZLnxpy3mXhwOXp1TmT0g5z1roDtJQOJclQrzYC+BI9ONKFA7MkG46PRCZqtFiRJ+vE5N2d0FiRmIjbPaI9LysyDRtXsk1LwoKsyITLS6pQTO6EX9W8W2pPi7A0RMFFZBgSIZAaKqmUdJQbXbgRXKB05IJ2clNVLFa7F2dmSWFlOj17fXw2/enq+HT65u0VFDTHRvkoISijF3u20ZotmzT0V0BYomoIZqTMTaDSnirRgTZA8znlLBrdYlUrEpMX4/F4nIlKalk1lZjwb7yNv/98yIvj9e9PwHW2sSlufDWYs0ZfbjOm81bqxQNbvtXyU0MgC9JeziXZje9QwHFHfaNR0TiyB4cvRNDkCemFL8Xk8Ks/ZeJ2Lzd6SdaHi62sxMTbhtYPNPz0a1k10lKRKH3IhMcFg1pwoBIfeIerjXbk+NLD8Zj/u29P31jt7ns+oGsjUQxgzlvCit0nN9qTjmLQrd8Pm/ivz+l1vWYhX267/VgvUckCpObYuReDBvoSOh/N4FNDdgVoF01FmmOBsS0qoMYVB1ooZMEBEmp0DgLNELpHcKScARuEpCIG0k6VjiwHBkvzxlEMWYlwxsC+KWVeQo6O0lJUJuRorSRWUG4KCqGJ1zfU0japnScswMwBYS5JFaCk80MVYl0rmQdm9392Zrsizezn6LpD7f24kRPIWsPRqLactryMFncefeO+NwU9IXT98+rqHOKJIFcf1y9DJIiXPOo3fUKMkIGDfIcFpBgi1pmoyDlc0ONEp3w3tNv7FAcYYppB1a5HEq3F1QOKJ9J5tk3EXjwUc8YcJWfKDkYcQDxVbptJhhp/sjw/dH8xE4yf7r7AQWOHcr4XNS7oUv5C7wVUjfMwIwhZ3peo2SnoU4MKvIGD8XjMmvhIq8c5OcOKWhZ6uvi8KjqWWob4rhBcH73sVaNU9PAn3ziCS+YQHXykVcoQ3tR7ipak4skMCuN9WwKAJsd/GD1UoDej8QiLwpJzgkOSlz4sdH4UUPaKSYpH1h1vyIee9RmZTzEvpaY9S6kiDH4UfCwDOQdcolS8MOD2FKWamdsz41+ZRgd+CvIolXv8xqOikPwTVbornRxeN4Krh5Ewxa6oyDYwVpEX2JTEzI3Uc/M/YCU6WJ+Vz1vqItHYpKCDhynoqPElZ9q88zwqUirCPA/+ZT6S5hq6ks5JveDkEPAZUtFNqD582Fx7KnYX3++x9sVj/MGOYvxbjY0vjZW/ULGjIH8aNQ84UMnA9kNtbbf/iy32jzYuSMvtdi8MRQMvLGrPL2sBBoyVUJdJ14ERnsUzLjc1Zd07lrFwfA4p9jC0vZXhFeb5DtEyEOSLg+XFjsDyytiZLArSO0JKH3zRDkw4lXVUXIYnj9LncBQOBzx09tVEBRVZV0jewwiXhiuQQxGxli0PXK6fbxD0ND56iIsQfBJL3SkHhQnMSZ2rpqD77CUtusmNlT5pqzKejlKqfBKTuZKkfQ/lDxiSHfC51jZgQt8hbSc34Olw/GI0Hh0cvBgdDJ08gPyHgPHtLv7yoYufGX6zbHTr3hswcP9F+hU82zhq0kXWprwMyOej552B6XanJXzH2hd32Jc7clhmeVOS7MBhLzbWaHN7m1Hn7S3/dZ01zCXxmq6y6uGrfbgVW4dfb3l/Rk+gZCUZGnlwRUaZMVBxL6ptYMENWYIKC2obbdwo7KWZ3UGqz9EXxtTh1zvC1JUxcMr6SmBwu8LWQ+uEwt6rJ4h+GVta0GgvVQwcHbkbqQtzwxGNvBs21fp4YgZO+MA2QH21vSXiyXK5nOrgCOI9QA2NptuaQviMT02eN9aGvgb3l2trGFBcJ/XC3O6QtZW1Lwevr3bWdNgwfhkZD8bYEcSONMitJmuN86VfFFvhNkLt+DVxEB8Hlw3gvM5iC31GJS4lm+yd+GMu8fS5xIekv0hCTASjQKSHC2uaWkwEyxiM70mH0i5MMEKb5572MxG65X9Y4TdagacHPX0ma2y0Ga1yb1O0TrcnWInb8RX50qTpoWhbZGJ/ebDPW/bvEi9rHkqE0BHt2VjFwyfvazfZ3w9dEdILqWmUvH6Um+qBN//bNBamvHkaNrfR6JmlWmGeCo8V78LcN124entx8jyw6y

1hvrPSrwMSM0JLll2oxefehv3zJ6SLG+v6mTbRhxtsxC/8dN4ks/XhlbIWes0yNnxp6GGo5xLR89gqkdb/nlMJRX9yj82O2Adn4ZiUOR385HI1T9sM8ZL80F+ofu2zq2lg2z1DtitDqUV/5WNf7hcndvtscCcscYOOTf9zbztFYyZw4Rm6//SSt3r+9T6ig5f7J8ffTs8vpT9PTo+OTODwb+VsvHkyP+sRra5ayCIOKi+nl1byJ3sWeUKHG4PuDmZLLgkfw8/alMPpWr7KIBwr0CJhb4xxUjfKyVpv7rBu91+/1dMljm3ZQw2+pjouYvk2zMK/hciZGGQw7ro/SC3yoUibwXYANfBOOfHsNcSobZuUarv8eCf4UVv92fW9aNIIrfh5jgXSuoSIIZGlpPoYecQhFqXeS9tahwRj70319YlHJlO3nmFOQsi1YARfIA584CeKG9UCz4f6kRe5L8CntJSq14lfhj0Q1SO9CBcODU+2k45ItA2fASVYxajJcJaFSLtiQvyRoyX9qqCFoaphRKfltEvMyvmCP4KQ/Tt30DZiS5hHCQi5JQ2U4WBpTdaH+uj8Sb9WePZj4drZOU4s0bnOdKsL3DqSXpExNE+7QNxVZmcN1VyxeZ4DgSmM9XIdq5BoUzkgFcyGUTYW6q4yuEz6vRzBlUUkXtZGxN2JpzsIUJo8DQzBardIwr1dqOpA+6CCyG+654aTgS1pBRaiDaGFi0dJKiPz1GBGmIcb5CnXP6+Ogtc3AMX1GCOP2L0ruurL9j49LfiflQ9bmwN5kfJ1i+13K/+/E8kBkbSk3aa3/IROlcZ7X7+5m6OitVes1Pw4RjZMwVxhWhpqcM3QhXdC6mMxROfoV+Dy7SK3H5/D0rwu2StJOVPWqV++INGncfG+x/rDO2o9nfhun//+fl3xGMb1ysPuIaKOgrmA8ClOi3lqfTL9kfD29Euv1fwBj7JLF",sidebar_class_name:"get api-method",info_path:"docs/api/emailengine-api",custom_edit_url:null,hide_send_button:!0},f=void 0,v={},b=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Return stored logs for an account"}),"\n",(0,r.jsx)(n(),{method:"get",path:"/v1/logs/{account}",context:"endpoint"}),"\n",(0,r.jsxs)(t.p,{children:["Output is a downloadable text file with one JSON log entry per line, or a plain-text notice when nothing is stored",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Nothing is stored unless logging is enabled for the account, either with the account logs flag or the global logs.all setting. IMAP accounts record the protocol trace, Gmail API and MS Graph accounts record their API requests, and SMTP transactions are recorded for any account that sends over SMTP."]}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"x-ee-timeout",in:"header",schema:{type:"integer",description:"Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect",example:3e4,minimum:0,maximum:72e5},description:"Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect"},{name:"account",in:"path",schema:{type:"string",description:"Unique identifier for the email account",example:"user123",maxLength:256,"x-convert":{trim:!0}},description:"Unique identifier for the email account",required:!0}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Returns the account log as a plain text stream.",content:{"text/plain":{schema:{type:"string"}}}},400:{description:"Invalid input - the path parameters, query arguments, or request payload did not pass validation. Also returned when the email server refused the request, in which case the response carries a code and the server response instead of a field list",content:{"application/json":{schema:{type:"object",description:"Validation error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:400},error:{type:"string",description:"HTTP status text",example:"Bad Request"},message:{type:"string",description:"Error message",example:"Invalid input"},fields:{type:"array",description:"List of input fields that failed validation",items:{type:"object",properties:{message:{type:"string",description:"Description of the validation failure",example:'"pageSize" must be less than or equal to 1000'},key:{type:"string",description:"Name of the input field that failed validation",example:"pageSize"},path:{type:"string",description:"Full path of the input field that failed validation. Same as key for a top-level field, dotted for a nested one",example:"to.0.address"}},title:"ValidationErrorField"},title:"ValidationErrorFields"},code:{type:"string",description:"Machine-readable error code, if available",example:"MailboxNotFound"},details:{type:"string",description:"Additional error details, if available. The email server response for a refused mailbox operation"},info:{type:"string",description:"Additional error details, if available. The email server response for a refused message operation"}},title:"ValidationErrorResponse"}}}},401:{description:"Authentication failed - the access token is missing, invalid, or was not accepted",content:{"application/json":{schema:{type:"object",description:"Authentication error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:401},error:{type:"string",description:"HTTP status text",example:"Unauthorized"},message:{type:"string",description:"Error message",example:"Missing authentication"}},title:"AuthenticationErrorResponse"}}}}

1,403:{description:"Access denied - the access token does not grant permission for this operation (token scope, account, or IP address restriction)",content:{"application/json":{schema:{type:"object",description:"Access denied error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:403},error:{type:"string",description:"HTTP status text",example:"Forbidden"},message:{type:"string",description:"Error message",example:"Unauthorized scope"},requestedScope:{type:"string",description:"The scope the operation needed, when the token does not carry it",example:"api"},requiredPermission:{type:"string",description:"The permission grant the operation needed, when the token permissions do not include it",example:"messages:write"},remoteAddress:{type:"string",description:"The client IP address, when the token is restricted to other addresses",example:"203.0.113.1"}},title:"AccessDeniedErrorResponse"}}}},404:{description:"Not found - the requested entity (account, message, mailbox, etc.) does not exist",content:{"application/json":{schema:{type:"object",description:"Not found error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:404},error:{type:"string",description:"HTTP status text",example:"Not Found"},message:{type:"string",description:"Error message",example:"Requested message was not found"},code:{type:"string",description:"Machine-readable error code",example:"MessageNotFound"}},title:"NotFoundErrorResponse"}}}},429:{description:"Rate limit exceeded - too many requests were made with this access token",content:{"application/json":{schema:{type:"object",description:"Rate limit error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:429},error:{type:"string",description:"HTTP status text",example:"Too Many Requests"},message:{type:"string",description:"Error message",example:"Rate limit exceeded"},ttl:{type:"integer",description:"Seconds until the rate limit window resets",example:30}},title:"RateLimitErrorResponse"}}}},500:{description:"Internal server error - an unexpected error occurred while processing the request",content:{"application/json":{schema:{type:"object",description:"Internal server error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:500},error:{type:"string",description:"HTTP status text",example:"Internal Server Error"},message:{type:"string",description:"Error message",example:"An internal server error occurred"},code:{type:"string",description:"Machine-readable error code, if available",example:"InternalError"},details:{type:"string",description:"Additional error details, if available"}},title:"InternalErrorResponse"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(y,{...e})}):y(e)}}}]);