JMAP Dart client
A JMAP client library to make JMAP method calls and process the responses.
We most notably use it to write the TMail Flutter application but you might reuse this library to write your own JMAP application.
We do welcome all contributions, given decent test coverage and acceptable code quality.
Please report any problem, any feature request, or discuss how you plan to use this lib in the repository issues.
Code samples
GetSession:
// create instance of httpClient with Dio
// using BasicAuth to config Dio
final httpClient = HttpClient(Dio());
final getSessionBuilder = GetSessionBuilder(httpClient);
final session = await getSessionBuilder.build().execute();
Fetching mailboxes
final processingInvocation = ProcessingInvocation();
final jmapRequestBuilder = JmapRequestBuilder(httpClient, processingInvocation);
final getMailboxMethod = GetMailboxMethod(accountId)
..addProperties(Properties({'role', 'name'}));
final queryInvocation = jmapRequestBuilder.invocation(getMailboxMethod);
final responseObject = await (jmapRequestBuilder
..usings(getMailboxCreated.requiredCapabilities))
.build()
.execute();
final getMailboxResponse = responseObject.parse<GetMailboxResponse>(
queryInvocation.methodCallId,
GetMailboxResponse.deserialize);
Get emails in Mailbox
final processingInvocation = ProcessingInvocation();
final jmapRequestBuilder = JmapRequestBuilder(httpClient, processingInvocation);
final queryEmailMethod = QueryEmailMethod(accountId)
..addPosition(0)
..addLimit(UnsignedInt(20))
..addSorts({EmailComparator(EmailComparatorProperty.sentAt)..setIsAscending(false)})
..addFilters(EmailFilterCondition(inMailbox: inBoxId));
final queryEmailInvocation = jmapRequestBuilder.invocation(queryEmailMethod);
final getEmailMethod = GetEmailMethod(accountId)
..addProperties(Properties({'id', 'subject','from', 'keywords', 'sentAt', 'preview', 'hasAttachment'}))
..addReferenceIds(processingInvocation.createResultReference(
queryEmailInvocation.methodCallId,
ReferencePath.idsPath));
final getEmailInvocation = jmapRequestBuilder.invocation(getEmailMethod);
final responseObject = await (jmapRequestBuilder
..usings(getEmailMethod.requiredCapabilities))
.build()
.execute();
final getEmailResponse = responseObject.parse<GetEmailResponse>(
getEmailInvocation.methodCallId,
GetEmailResponse.deserialize);
0 Oct 27, 2021
4 Nov 13, 2022
2 Apr 22, 2022
1 Dec 29, 2021
73 Jan 7, 2023
3 Dec 15, 2021
2 Mar 15, 2022
273 Dec 27, 2022
4 Aug 20, 2022
56 Dec 16, 2022
45 Sep 21, 2022
7 Nov 6, 2022
2 Oct 8, 2021
5 Oct 10, 2021
2 Apr 18, 2022
10 Oct 26, 2022
4 Sep 12, 2022
3 Nov 21, 2021