You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: OPENAPI-REST-API/openapi-client/ada/src/client/-clients.adb
+35-7Lines changed: 35 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
-- The version of the OpenAPI document: 0.9.0
5
5
-- Contact: support@interserver.net
6
6
--
7
-
-- NOTE: This package is auto generated by OpenAPI-Generator 7.20.0.
7
+
-- NOTE: This package is auto generated by OpenAPI-Generator 7.21.0.
8
8
-- https://openapi-generator.tech
9
9
-- Do not edit the class manually.
10
10
@@ -2516,6 +2516,22 @@ package body .Clients is
2516
2516
2517
2517
-- View Mail Log
2518
2518
-- Returns a paginated log of emails sent through this mail service, with optional filtering by sender, recipient, date range, and delivery status.
2519
+
--
2520
+
-- **Row grouping** is controlled by the `groupby` parameter. By default (`groupby=recipient`), the response contains one row per delivery attempt — so a single message sent to 4 recipients produces 4 rows, each with its own `recipient`, `delivered`, `response`, and `mxHostname` values. Set `groupby=message` to collapse to one row per message (delivery fields will reflect one arbitrary recipient).
2521
+
--
2522
+
-- **Pagination** is controlled by `skip` and `limit`. The `total` in the response reflects the row count **after** grouping, so it matches the number of pages you need to fetch.
2523
+
--
2524
+
-- **Date filtering** accepts either a Unix timestamp (integer) or a date string parseable by PHP `strtotime()` such as `2024-01-15`, `last monday`, or `2024-01-01 00:00:00`. Examples: `startDate=1704067200&endDate=1706745599` or `startDate=2024-01-01&endDate=2024-01-31`.
2525
+
--
2526
+
-- **Sorting** is controlled by `sort` and `dir`. Currently the only sort key is `time` (default), which orders by internal row ID.
2527
+
--
2528
+
-- **Delivery status** can be filtered with the `delivered` parameter: `delivered=1` returns only successfully delivered messages; `delivered=0` returns messages still in queue or that failed.
2529
+
--
2530
+
-- **Address filtering** distinguishes between the SMTP envelope address (`from`, `to`) and message headers (`headerfrom` for the `From:` header, `replyto` for `Reply-To:`). These may differ when a message is sent on behalf of another address.
2531
+
--
2532
+
-- The `mailid` parameter corresponds to the `id` field in the returned `MailLogEntry` objects, **not** the `_id` field. It also matches the transaction ID returned in the `text` field of a successful send response.
2533
+
--
2534
+
-- The `messageId` parameter searches the `Message-ID` email header (case-insensitive substring match).
2519
2535
procedureView_Mail_Log
2520
2536
(Client : inout Client_Type;
2521
2537
Id : in Integer;
@@ -2526,11 +2542,17 @@ package body .Clients is
2526
2542
To : in Swagger.Nullable_UString;
2527
2543
Subject : in Swagger.Nullable_UString;
2528
2544
Mailid : in Swagger.Nullable_UString;
2545
+
Message_Id : in Swagger.Nullable_UString;
2546
+
Replyto : in Swagger.Nullable_UString;
2547
+
Headerfrom : in Swagger.Nullable_UString;
2548
+
Delivered : in Swagger.Nullable_Integer;
2529
2549
Skip : in Swagger.Nullable_Integer;
2530
2550
Limit : in Swagger.Nullable_Integer;
2531
-
Start_Date : in Swagger.Nullable_Long;
2532
-
End_Date : in Swagger.Nullable_Long;
2533
-
Delivered : in Swagger.Nullable_UString;
2551
+
Start_Date : in .Models.ViewMailLogStartDateParameter_Type;
2552
+
End_Date : in .Models.ViewMailLogStartDateParameter_Type;
Copy file name to clipboardExpand all lines: OPENAPI-REST-API/openapi-client/ada/src/client/-clients.ads
+26-4Lines changed: 26 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
-- The version of the OpenAPI document: 0.9.0
5
5
-- Contact: support@interserver.net
6
6
--
7
-
-- NOTE: This package is auto generated by OpenAPI-Generator 7.20.0.
7
+
-- NOTE: This package is auto generated by OpenAPI-Generator 7.21.0.
8
8
-- https://openapi-generator.tech
9
9
-- Do not edit the class manually.
10
10
@@ -977,6 +977,22 @@ package .Clients is
977
977
978
978
-- View Mail Log
979
979
-- Returns a paginated log of emails sent through this mail service, with optional filtering by sender, recipient, date range, and delivery status.
980
+
--
981
+
-- **Row grouping** is controlled by the `groupby` parameter. By default (`groupby=recipient`), the response contains one row per delivery attempt — so a single message sent to 4 recipients produces 4 rows, each with its own `recipient`, `delivered`, `response`, and `mxHostname` values. Set `groupby=message` to collapse to one row per message (delivery fields will reflect one arbitrary recipient).
982
+
--
983
+
-- **Pagination** is controlled by `skip` and `limit`. The `total` in the response reflects the row count **after** grouping, so it matches the number of pages you need to fetch.
984
+
--
985
+
-- **Date filtering** accepts either a Unix timestamp (integer) or a date string parseable by PHP `strtotime()` such as `2024-01-15`, `last monday`, or `2024-01-01 00:00:00`. Examples: `startDate=1704067200&endDate=1706745599` or `startDate=2024-01-01&endDate=2024-01-31`.
986
+
--
987
+
-- **Sorting** is controlled by `sort` and `dir`. Currently the only sort key is `time` (default), which orders by internal row ID.
988
+
--
989
+
-- **Delivery status** can be filtered with the `delivered` parameter: `delivered=1` returns only successfully delivered messages; `delivered=0` returns messages still in queue or that failed.
990
+
--
991
+
-- **Address filtering** distinguishes between the SMTP envelope address (`from`, `to`) and message headers (`headerfrom` for the `From:` header, `replyto` for `Reply-To:`). These may differ when a message is sent on behalf of another address.
992
+
--
993
+
-- The `mailid` parameter corresponds to the `id` field in the returned `MailLogEntry` objects, **not** the `_id` field. It also matches the transaction ID returned in the `text` field of a successful send response.
994
+
--
995
+
-- The `messageId` parameter searches the `Message-ID` email header (case-insensitive substring match).
980
996
procedureView_Mail_Log
981
997
(Client : inout Client_Type;
982
998
Id : in Integer;
@@ -987,11 +1003,17 @@ package .Clients is
987
1003
To : in Swagger.Nullable_UString;
988
1004
Subject : in Swagger.Nullable_UString;
989
1005
Mailid : in Swagger.Nullable_UString;
1006
+
Message_Id : in Swagger.Nullable_UString;
1007
+
Replyto : in Swagger.Nullable_UString;
1008
+
Headerfrom : in Swagger.Nullable_UString;
1009
+
Delivered : in Swagger.Nullable_Integer;
990
1010
Skip : in Swagger.Nullable_Integer;
991
1011
Limit : in Swagger.Nullable_Integer;
992
-
Start_Date : in Swagger.Nullable_Long;
993
-
End_Date : in Swagger.Nullable_Long;
994
-
Delivered : in Swagger.Nullable_UString;
1012
+
Start_Date : in .Models.ViewMailLogStartDateParameter_Type;
1013
+
End_Date : in .Models.ViewMailLogStartDateParameter_Type;
0 commit comments