You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by "René Cordier (Jira)" <se...@james.apache.org> on 2020/03/06 09:25:00 UTC

[jira] [Updated] (JAMES-3091) mailboxes/get POJO and serialization

     [ https://issues.apache.org/jira/browse/JAMES-3091?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

René Cordier updated JAMES-3091:
--------------------------------
    Description: 
Mailboxes get method should follow the
 - JMAP core specification section /get
 - JMAP Mail specification section Mailboxes/get

*JMAP core specification section /get*
 Reference: [https://jmap.io/spec-core.html#get]

required types:
 - Id: JMAP Id type [https://jmap.io/spec-core.html#the-id-data-type]
 - String

*Request*
{code:json}
{
   "using": ["capability1", "capability2",...],
   "methodCalls": [
       [
           "Mailbox/get", 
           {
                "accountId": "JMAP-ID",
                "ids": ["JMAP-ID-1", "JMAP-ID-2", ...],
                "properties": ["prop1", "prop2", ...]
           }
       ]
   ]
}
{code}
*Response*
{code:java}
{
   "methodResponses": [
       [
           "Mailbox/get", 
           {
                "accountId": "JMAP-ID", // the requested accountId
                "state": "state-in-the-scope-of-all-mailboxes-associated-with-account-id"
                "list": [
                    {
                        "prop1": "val1",
                        "prop2": "val2",
                        ...
                    },
                    ...
                ],
                "notFound": ["JMAP-ID-1", "JMAP-ID-2", ...]
           }
       ]
   ], 
   "sessionState": "abc"
}
{code}
*JMAP Mail specification section Mailboxes/get*

Reference [https://jmap.io/spec-mail.html#mailboxes]

*DOD*:
 - implement POJOs and the serializer if needed
 - tests to match the rules of mailboxes/get request specified in the spec

  was:
Mailboxes get method should follow the
 - JMAP core specification section /get
 - JMAP Mail specification section Mailboxes/get

## JMAP core specification section /get
Reference: https://jmap.io/spec-core.html#get

required types:
 - Id: JMAP Id type https://jmap.io/spec-core.html#the-id-data-type
 - String

### Request

{code:json}
{
   "using": ["capability1", "capability2",...],
   "methodCalls": [
       [
           "Mailbox/get", 
           {
                "accountId": "JMAP-ID",
                "ids": ["JMAP-ID-1", "JMAP-ID-2", ...],
                "properties": ["prop1", "prop2", ...]
           }
       ]
   ]
}
{code}


### Response
{code:java}
{
   "methodResponses": [
       [
           "Mailbox/get", 
           {
                "accountId": "JMAP-ID", // the requested accountId
                "state": "state-in-the-scope-of-all-mailboxes-associated-with-account-id"
                "list": [
                    {
                        "prop1": "val1",
                        "prop2": "val2",
                        ...
                    },
                    ...
                ],
                "notFound": ["JMAP-ID-1", "JMAP-ID-2", ...]
           }
       ]
   ], 
   "sessionState": "abc"
}
{code}

## JMAP Mail specification section Mailboxes/get

Reference https://jmap.io/spec-mail.html#mailboxes

*DOD*:
 - implement POJOs and the serializer if needed
 - tests to match the rules of mailboxes/get request specified in the spec



> mailboxes/get POJO and serialization
> ------------------------------------
>
>                 Key: JAMES-3091
>                 URL: https://issues.apache.org/jira/browse/JAMES-3091
>             Project: James Server
>          Issue Type: Improvement
>            Reporter: René Cordier
>            Priority: Major
>
> Mailboxes get method should follow the
>  - JMAP core specification section /get
>  - JMAP Mail specification section Mailboxes/get
> *JMAP core specification section /get*
>  Reference: [https://jmap.io/spec-core.html#get]
> required types:
>  - Id: JMAP Id type [https://jmap.io/spec-core.html#the-id-data-type]
>  - String
> *Request*
> {code:json}
> {
>    "using": ["capability1", "capability2",...],
>    "methodCalls": [
>        [
>            "Mailbox/get", 
>            {
>                 "accountId": "JMAP-ID",
>                 "ids": ["JMAP-ID-1", "JMAP-ID-2", ...],
>                 "properties": ["prop1", "prop2", ...]
>            }
>        ]
>    ]
> }
> {code}
> *Response*
> {code:java}
> {
>    "methodResponses": [
>        [
>            "Mailbox/get", 
>            {
>                 "accountId": "JMAP-ID", // the requested accountId
>                 "state": "state-in-the-scope-of-all-mailboxes-associated-with-account-id"
>                 "list": [
>                     {
>                         "prop1": "val1",
>                         "prop2": "val2",
>                         ...
>                     },
>                     ...
>                 ],
>                 "notFound": ["JMAP-ID-1", "JMAP-ID-2", ...]
>            }
>        ]
>    ], 
>    "sessionState": "abc"
> }
> {code}
> *JMAP Mail specification section Mailboxes/get*
> Reference [https://jmap.io/spec-mail.html#mailboxes]
> *DOD*:
>  - implement POJOs and the serializer if needed
>  - tests to match the rules of mailboxes/get request specified in the spec



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org