Add a WebAdmin API allowing listing user default identity

[quantranhong1999]

Why

• API to list identities of a user

  GET /users/{username}/identities
  [{
      "name": "bob@domain.tld",
      "email": "bob@domain.tld",
      "htmlSignature": "",
      "id": "a5f670c5-d5e0-3b22-8197-02a9c37cad27",
      "textSignature": "",
      "mayDelete": false,
      "bcc": [{
          "email": "boss2@domain.tld",
          "name": "My Boss 2"
      }],
      "replyTo": [{
          "email": "boss@domain.tld",
          "name": "My Boss"
      }],
      "sortOrder": 0
  },
  {
      "id": "3739a34e-cd8c-3a42-bf28-578ba24da9da",
      "name": "bob-alias@domain.tld",
      "email": "bob-alias@domain.tld",
      "mayDelete": false,
      "textSignature": "",
      "htmlSignature": "",
      "bcc": [{
          "email": "boss2@domain.tld",
          "name": "My Boss 2"
      }],
      "replyTo": [{
          "email": "boss@domain.tld",
          "name": "My Boss"
      }],
      "sortOrder": 1
  },
  {
      "id": "3739a34e-cd8c-3a42-bf28-578ba24da8da",
      "name": "james-team-mailbox@domain.tld",
      "email": "james-team-mailbox@domain.tld",
      "mayDelete": false,
      "textSignature": "",
      "htmlSignature": "",
      "bcc": [{
          "email": "boss2@domain.tld",
          "name": "My Boss 2"
      }],
      "replyTo": [{
          "email": "boss@domain.tld",
          "name": "My Boss"
      }],
      "sortOrder": 2
  },
  {
      "id": "3739a34e-cd8c-3a42-bf28-578ba24da8ds",
      "name": "Bob default identity",
      "email": "bob@domain.tld",
      "mayDelete": true,
      "textSignature": "",
      "htmlSignature": "",
      "bcc": [{
          "email": "boss2@domain.tld",
          "name": "My Boss 2"
      }],
      "replyTo": [{
          "email": "boss@domain.tld",
          "name": "My Boss"
      }],
      "sortOrder": 3
  }
  ]

• API to get the default identity of a user

  GET /users/{username}/identities?default=true
  {
  "id": "3739a34e-cd8c-3a42-bf28-578ba24da8ds",
  "name": "Bob default identity",
  "email": "bob@domain.tld",
  "mayDelete": true,
  "textSignature": "",
  "htmlSignature": "",
  "bcc": [{
      "email": "boss2@domain.tld",
      "name": "My Boss 2"
  }],
  "replyTo": [{
      "email": "boss@domain.tld",
      "name": "My Boss"
  }],
  "sortOrder": 3
  }

  Filtering the mayDelete=true with the highest priority sortOrder (smallest integer) Otherwise, return 404 not found.

How

Use IdentityRepository list API

DoD

• Test
• Documentation

[chibenwa]

The endpoint could be GET /users/{username}/identities

[chibenwa]

API to get the default identity of a user

May not be needed? The LSC plugin would use the first identity that have mayDelete=true as a pivot, create if none with maximum amount of fields populated with the LDAP data.

[chibenwa]

Misses sortOrder field, replyTo, bcc fields.

[quantranhong1999]

May not be needed? The LSC plugin would use the first identity that have mayDelete=true as a pivot, create if none with maximum amount of fields populated with the LDAP data.

Maybe. But I am not sure filtering on the LSC side could be done easily (long time no touch LSC), so I will let the GET default identity API for now.

[vttranlina]

PR https://github.com/apache/james-project/pull/1470

[vttranlina]

With default=true parameter, the response should return json list (containing [] character) Eg:

[
{
    "id": "3739a34e-cd8c-3a42-bf28-578ba24da8ds",
    "name": "Bob default identity",
    "email": "bob@domain.tld",
    ...
    "sortOrder": 3
}
]

Because the default is just a query parameter, and the endpoint is not changed.

[vttranlina]

Jira: https://issues.apache.org/jira/browse/JAMES-3893