https://developer.mittwald.de/de/assets/js/384429a6.551a8a90.js

1"use strict";(self.webpackChunkapi_docs=self.webpackChunkapi_docs||[]).push([[7428],{82638:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"reference/mail/mail-list-delivery-boxes","title":"List delivery boxes belonging to a Project","description":"","source":"@site/docs/reference/mail/mail-list-delivery-boxes.mdx","sourceDirName":"reference/mail","slug":"/reference/mail/mail-list-delivery-boxes","permalink":"/de/docs/v2/reference/mail/mail-list-delivery-boxes","draft":false,"unlisted":false,"editUrl":"https://github.com/mittwald/developer-portal/tree/master/docs/reference/mail/mail-list-delivery-boxes.mdx","tags":[],"version":"current","frontMatter":{"title":"List delivery boxes belonging to a Project","description":"","openapi":{"method":"get"}},"sidebar":"apiSidebar","previous":{"title":"Update mail-address","permalink":"/de/docs/v2/reference/mail/deprecated-mail-mailaddress-update-address"},"next":{"title":"Create a delivery box","permalink":"/de/docs/v2/reference/mail/mail-create-deliverybox"}}');var a=r(74848),n=r(28453),s=r(82390),o=r(45676),p=r(84990);r(20570),r(50776),r(36413),r(21481),r(19365);const d={title:"List delivery boxes belonging to a Project",description:"",openapi:{method:"get"}},c=void 0,m={},l=[{value:"Request",id:"request",level:2},{value:"Responses",id:"responses",level:2},{value:"Usage examples",id:"usage-examples",level:2}];function h(e){const t={h2:"h2",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(o.X,{path:"/v2/projects/{projectId}/delivery-boxes",method:"get",spec:{operationId:"mail-list-delivery-boxes",parameters:[{description:"ID of the Project to list DeliveryBoxes for.",examples:{shortId:{value:"p-ab1cd2"},uuid:{value:"0b15641e-26e2-4e56-9b83-96a995c8bf05"}},in:"path",name:"projectId",required:!0,schema:{type:"string"}},{description:"Search term to filter DeliveryBoxes for. The fields id, name and description are searchable. An exact match is performed for id, a partial match for name and description.",in:"query",name:"search",required:!1,schema:{type:"string"}},{name:"limit",in:"query",description:"The max count of resources to return in the list response.",schema:{type:"integer",default:1e4,minimum:0},required:!1},{name:"skip",in:"query",description:"Number of items to skip. Should be multiple of `limit`.",schema:{type:"integer",default:0},required:!1},{name:"page",in:"query",description:"Page to display. `skip` and `page` end up doing the same. If both `page` and `skip` are set, skip is used.",schema:{type:"integer",minimum:0},required:!1}],responses:{200:{content:{"application/json":{schema:{items:{properties:{authenticationEnabled:{type:"boolean"},description:{type:"string"},id:{format:"uuid",type:"string"},name:{type:"string"},passwordUpdatedAt:{format:"date-time",type:"string"},projectId:{type:"string"},sendingEnabled:{type:"boolean"},updatedAt:{format:"date-time",type:"string"}},required:["id","name","projectId","description","authenticationEnabled","sendingEnabled","passwordUpdatedAt","updatedAt"],type:"object"},type:"array"}}}

1,description:"OK",headers:{"X-Pagination-Limit":{description:"The limit used to select the resources for the response",schema:{type:"integer"}},"X-Pagination-Skip":{description:"The number of skipped items",schema:{type:"integer"}},"X-Pagination-Page":{description:"The calculate page of the list response. Refer to parameters to learn more.",schema:{type:"number"}},"X-Pagination-TotalCount":{description:"The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.",schema:{type:"integer"}}}},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},500:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},503:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"List DeliveryBoxes belonging to a Project.",tags:["Mail"]},baseURL:"https://api.mittwald.de/v2",withDescription:!0}),"\n",(0,a.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(s.Xy,{spec:{operationId:"mail-list-delivery-boxes",parameters:[{description:"ID of the Project to list DeliveryBoxes for.",examples:{shortId:{value:"p-ab1cd2"},uuid:{value:"0b15641e-26e2-4e56-9b83-96a995c8bf05"}},in:"path",name:"projectId",required:!0,schema:{type:"string"}},{description:"Search term to filter DeliveryBoxes for. The fields id, name and description are searchable. An exact match is performed for id, a partial match for name and description.",in:"query",name:"search",required:!1,schema:{type:"string"}},{name:"limit",in:"query",description:"The max count of resources to return in the list response.",schema:{type:"integer",default:1e4,minimum:0},required:!1},{name:"skip",in:"query",description:"Number of items to skip. Should be multiple of `limit`.",schema:{type:"integer",default:0},required:!1},{name:"page",in:"query",description:"Page to display. `skip` and `page` end up doing the same. If both `page` and `skip` are set, skip is used.",schema:{type:"integer",minimum:0},required:!1}],responses:{200:{content:{"application/json":{schema:{items:{properties:{authenticationEnabled:{type:"boolean"},description:{type:"string"},id:{format:"uuid",type:"string"},name:{type:"string"},passwordUpdatedAt:{format:"date-time",type:"string"},projectId:{type:"string"},sendingEnabled:{type:"boolean"},updatedAt:{format:"date-time",type:"string"}},required:["id","name","projectId","description","authenticationEnabled","sendingEnabled","passwordUpdatedAt","updatedAt"],type:"object"},type:"array"}}}

1,description:"OK",headers:{"X-Pagination-Limit":{description:"The limit used to select the resources for the response",schema:{type:"integer"}},"X-Pagination-Skip":{description:"The number of skipped items",schema:{type:"integer"}},"X-Pagination-Page":{description:"The calculate page of the list response. Refer to parameters to learn more.",schema:{type:"number"}},"X-Pagination-TotalCount":{description:"The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.",schema:{type:"integer"}}}},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},500:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},503:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"List DeliveryBoxes belonging to a Project.",tags:["Mail"]}}),"\n",(0,a.jsx)(t.h2,{id:"responses",children:"Responses"}),"\n",(0,a.jsx)(s.SL,{spec:{operationId:"mail-list-delivery-boxes",parameters:[{description:"ID of the Project to list DeliveryBoxes for.",examples:{shortId:{value:"p-ab1cd2"},uuid:{value:"0b15641e-26e2-4e56-9b83-96a995c8bf05"}},in:"path",name:"projectId",required:!0,schema:{type:"string"}},{description:"Search term to filter DeliveryBoxes for. The fields id, name and description are searchable. An exact match is performed for id, a partial match for name and description.",in:"query",name:"search",required:!1,schema:{type:"string"}},{name:"limit",in:"query",description:"The max count of resources to return in the list response.",schema:{type:"integer",default:1e4,minimum:0},required:!1},{name:"skip",in:"query",description:"Number of items to skip. Should be multiple of `limit`.",schema:{type:"integer",default:0},required:!1},{name:"page",in:"query",description:"Page to display. `skip` and `page` end up doing the same. If both `page` and `skip` are set, skip is used.",schema:{type:"integer",minimum:0},required:!1}],responses:{200:{content:{"application/json":{schema:{items:{properties:{authenticationEnabled:{type:"boolean"},description:{type:"string"},id:{format:"uuid",type:"string"},name:{type:"string"},passwordUpdatedAt:{format:"date-time",type:"string"},projectId:{type:"string"},sendingEnabled:{type:"boolean"},updatedAt:{format:"date-time",type:"string"}},required:["id","name","projectId","description","authenticationEnabled","sendingEnabled","passwordUpdatedAt","updatedAt"],type:"object"},type:"array"}}}

1,description:"OK",headers:{"X-Pagination-Limit":{description:"The limit used to select the resources for the response",schema:{type:"integer"}},"X-Pagination-Skip":{description:"The number of skipped items",schema:{type:"integer"}},"X-Pagination-Page":{description:"The calculate page of the list response. Refer to parameters to learn more.",schema:{type:"number"}},"X-Pagination-TotalCount":{description:"The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.",schema:{type:"integer"}}}},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},500:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},503:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"List DeliveryBoxes belonging to a Project.",tags:["Mail"]}}),"\n",(0,a.jsx)(t.h2,{id:"usage-examples",children:"Usage examples"}),"\n",(0,a.jsx)(p.t,{method:"get",url:"/v2/projects/{projectId}/delivery-boxes",spec:{operationId:"mail-list-delivery-boxes",parameters:[{description:"ID of the Project to list DeliveryBoxes for.",examples:{shortId:{value:"p-ab1cd2"},uuid:{value:"0b15641e-26e2-4e56-9b83-96a995c8bf05"}},in:"path",name:"projectId",required:!0,schema:{type:"string"}},{description:"Search term to filter DeliveryBoxes for. The fields id, name and description are searchable. An exact match is performed for id, a partial match for name and description.",in:"query",name:"search",required:!1,schema:{type:"string"}},{name:"limit",in:"query",description:"The max count of resources to return in the list response.",schema:{type:"integer",default:1e4,minimum:0},required:!1},{name:"skip",in:"query",description:"Number of items to skip. Should be multiple of `limit`.",schema:{type:"integer",default:0},required:!1},{name:"page",in:"query",description:"Page to display. `skip` and `page` end up doing the same. If both `page` and `skip` are set, skip is used.",schema:{type:"integer",minimum:0},required:!1}],responses:{200:{content:{"application/json":{schema:{items:{properties:{authenticationEnabled:{type:"boolean"},description:{type:"string"},id:{format:"uuid",type:"string"},name:{type:"string"},passwordUpdatedAt:{format:"date-time",type:"string"},projectId:{type:"string"},sendingEnabled:{type:"boolean"},updatedAt:{format:"date-time",type:"string"}},required:["id","name","projectId","description","authenticationEnabled","sendingEnabled","passwordUpdatedAt","updatedAt"],type:"object"},type:"array"}}}

1,description:"OK",headers:{"X-Pagination-Limit":{description:"The limit used to select the resources for the response",schema:{type:"integer"}},"X-Pagination-Skip":{description:"The number of skipped items",schema:{type:"integer"}},"X-Pagination-Page":{description:"The calculate page of the list response. Refer to parameters to learn more.",schema:{type:"number"}},"X-Pagination-TotalCount":{description:"The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.",schema:{type:"integer"}}}},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},500:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},503:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"List DeliveryBoxes belonging to a Project.",tags:["Mail"]},baseURL:"https://api.mittwald.de/v2",withJavascript:!0,withPHP:!0})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]);