@@ -82,7 +82,7 @@ func (r *InboundEmailService) New(ctx context.Context, body InboundEmailNewParam
8282 return res , err
8383}
8484
85- // Retrieve details of a specific mailbox including statistics.
85+ // Retrieve details of a specific inbound email including statistics.
8686func (r * InboundEmailService ) Get (ctx context.Context , inboundEmailID string , opts ... option.RequestOption ) (res * InboundEmailGetResponse , err error ) {
8787 opts = slices .Concat (r .Options , opts )
8888 if inboundEmailID == "" {
@@ -94,8 +94,8 @@ func (r *InboundEmailService) Get(ctx context.Context, inboundEmailID string, op
9494 return res , err
9595}
9696
97- // List all mailboxes associated with your API key. Returns active and inactive
98- // mailboxes (deleted mailboxes are excluded).
97+ // List all inbound emails associated with your API key. Returns active and paused
98+ // inbound emails (deleted ones are excluded).
9999func (r * InboundEmailService ) List (ctx context.Context , query InboundEmailListParams , opts ... option.RequestOption ) (res * InboundEmailListResponse , err error ) {
100100 opts = slices .Concat (r .Options , opts )
101101 path := "v4/inbound-email"
@@ -124,10 +124,10 @@ type InboundEmailNewResponse struct {
124124 //
125125 // Any of "cdsl", "nsdl", "cams", "kfintech".
126126 AllowedSources []string `json:"allowed_sources"`
127- // Webhook URL for email notifications. `null` means files are only retrievable via
128- // `GET /v4/inbound-email/{id}/files` (pull delivery) .
129- CallbackURL string `json:"callback_url" api:"nullable" format:"uri"`
130- // When the mailbox was created
127+ // Webhook URL for email notifications. If set, we POST each parsed email here. If
128+ // omitted, files are only retrievable via `GET /v4/inbound-email/{id}/files`.
129+ CallbackURL string `json:"callback_url" format:"uri"`
130+ // When the inbound email was created
131131 CreatedAt time.Time `json:"created_at" format:"date-time"`
132132 // The inbound email address to forward CAS statements to
133133 Email string `json:"email" format:"email"`
@@ -137,11 +137,11 @@ type InboundEmailNewResponse struct {
137137 Metadata map [string ]string `json:"metadata"`
138138 // Your internal reference identifier
139139 Reference string `json:"reference" api:"nullable"`
140- // Current mailbox status
140+ // Current inbound email lifecycle status
141141 //
142142 // Any of "active", "paused".
143143 Status InboundEmailNewResponseStatus `json:"status"`
144- // When the mailbox was last updated
144+ // When the inbound email was last updated
145145 UpdatedAt time.Time `json:"updated_at" format:"date-time"`
146146 // JSON contains metadata for fields, check presence with [respjson.Field.Valid].
147147 JSON struct {
@@ -165,7 +165,7 @@ func (r *InboundEmailNewResponse) UnmarshalJSON(data []byte) error {
165165 return apijson .UnmarshalRoot (data , r )
166166}
167167
168- // Current mailbox status
168+ // Current inbound email lifecycle status
169169type InboundEmailNewResponseStatus string
170170
171171const (
@@ -179,10 +179,10 @@ type InboundEmailGetResponse struct {
179179 //
180180 // Any of "cdsl", "nsdl", "cams", "kfintech".
181181 AllowedSources []string `json:"allowed_sources"`
182- // Webhook URL for email notifications. `null` means files are only retrievable via
183- // `GET /v4/inbound-email/{id}/files` (pull delivery) .
184- CallbackURL string `json:"callback_url" api:"nullable" format:"uri"`
185- // When the mailbox was created
182+ // Webhook URL for email notifications. If set, we POST each parsed email here. If
183+ // omitted, files are only retrievable via `GET /v4/inbound-email/{id}/files`.
184+ CallbackURL string `json:"callback_url" format:"uri"`
185+ // When the inbound email was created
186186 CreatedAt time.Time `json:"created_at" format:"date-time"`
187187 // The inbound email address to forward CAS statements to
188188 Email string `json:"email" format:"email"`
@@ -192,11 +192,11 @@ type InboundEmailGetResponse struct {
192192 Metadata map [string ]string `json:"metadata"`
193193 // Your internal reference identifier
194194 Reference string `json:"reference" api:"nullable"`
195- // Current mailbox status
195+ // Current inbound email lifecycle status
196196 //
197197 // Any of "active", "paused".
198198 Status InboundEmailGetResponseStatus `json:"status"`
199- // When the mailbox was last updated
199+ // When the inbound email was last updated
200200 UpdatedAt time.Time `json:"updated_at" format:"date-time"`
201201 // JSON contains metadata for fields, check presence with [respjson.Field.Valid].
202202 JSON struct {
@@ -220,7 +220,7 @@ func (r *InboundEmailGetResponse) UnmarshalJSON(data []byte) error {
220220 return apijson .UnmarshalRoot (data , r )
221221}
222222
223- // Current mailbox status
223+ // Current inbound email lifecycle status
224224type InboundEmailGetResponseStatus string
225225
226226const (
@@ -259,10 +259,10 @@ type InboundEmailListResponseInboundEmail struct {
259259 //
260260 // Any of "cdsl", "nsdl", "cams", "kfintech".
261261 AllowedSources []string `json:"allowed_sources"`
262- // Webhook URL for email notifications. `null` means files are only retrievable via
263- // `GET /v4/inbound-email/{id}/files` (pull delivery) .
264- CallbackURL string `json:"callback_url" api:"nullable" format:"uri"`
265- // When the mailbox was created
262+ // Webhook URL for email notifications. If set, we POST each parsed email here. If
263+ // omitted, files are only retrievable via `GET /v4/inbound-email/{id}/files`.
264+ CallbackURL string `json:"callback_url" format:"uri"`
265+ // When the inbound email was created
266266 CreatedAt time.Time `json:"created_at" format:"date-time"`
267267 // The inbound email address to forward CAS statements to
268268 Email string `json:"email" format:"email"`
@@ -272,11 +272,11 @@ type InboundEmailListResponseInboundEmail struct {
272272 Metadata map [string ]string `json:"metadata"`
273273 // Your internal reference identifier
274274 Reference string `json:"reference" api:"nullable"`
275- // Current mailbox status
275+ // Current inbound email lifecycle status
276276 //
277277 // Any of "active", "paused".
278278 Status string `json:"status"`
279- // When the mailbox was last updated
279+ // When the inbound email was last updated
280280 UpdatedAt time.Time `json:"updated_at" format:"date-time"`
281281 // JSON contains metadata for fields, check presence with [respjson.Field.Valid].
282282 JSON struct {
0 commit comments