[james-project] branch master updated: JAMES-3445 Update Email/set documentation

[rc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git


The following commit(s) were added to refs/heads/master by this push:
     new 35e4974  JAMES-3445 Update Email/set documentation
35e4974 is described below

commit 35e497445e510d29ef8ffaf98f753a85ee84023d
Author: LanKhuat <dl...@linagora.com>
AuthorDate: Fri Nov 13 16:29:19 2020 +0700

    JAMES-3445 Update Email/set documentation
---
 .../jmap-rfc-8621/doc/specs/spec/mail/message.mdown         | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/server/protocols/jmap-rfc-8621/doc/specs/spec/mail/message.mdown b/server/protocols/jmap-rfc-8621/doc/specs/spec/mail/message.mdown
index 52306f6..09ad09d 100644
--- a/server/protocols/jmap-rfc-8621/doc/specs/spec/mail/message.mdown
+++ b/server/protocols/jmap-rfc-8621/doc/specs/spec/mail/message.mdown
@@ -828,7 +828,7 @@ This is a standard "/queryChanges" method as described in [@!RFC8620], Section 5
 ## Email/set
 
 <aside class="warning">
-Not implemented yet
+Partially implemented
 </aside>
 
 This is a standard "/set" method as described in [@!RFC8620], Section 5.3. The *Email/set* method encompasses:
@@ -852,17 +852,17 @@ Due to the format of the Email object, when creating an Email there are a number
 - Header fields beginning with `Content-` MUST NOT be specified on the Email
   object, only on EmailBodyPart objects.
 - If a bodyStructure property is given, there MUST NOT be textBody, htmlBody, or
-  attachments properties.
+  attachments properties. <aside class="warning">Not implemented. *bodyStructure* property is not supported in Email/set create.</aside>
 - If given, the bodyStructure EmailBodyPart MUST NOT contain a property
   representing a header field that is already defined on the top-level Email
-  object.
+  object. <aside class="warning">Not implemented. *bodyStructure* property is not supported in Email/set create.</aside>
 - If given, textBody MUST contain exactly one body part and it MUST be of type
-  `text/plain`.
+  `text/plain`. <aside class="warning">Not implemented. *textBody* property is not supported in Email/set create.</aside>
 - If given, htmlBody MUST contain exactly one body part and it MUST be of type
   `text/html`.
 - Within an EmailBodyPart:
-  - The client may specify a partId OR a blobId, but not both. If a partId is
-    given, this partId MUST be present in the bodyValues property.
+  - The client may specify a *partId* OR a *blobId*, but not both. If a *partId* is
+    given, this *partId* MUST be present in the bodyValues property. <aside>htmlBody part needs to have a *partId*. `attachments` parts need to specify *blobId*. </aside>
   - The charset property MUST be omitted if a partId is given (the part's
     content is included in bodyValues, and the server may choose any appropriate
     encoding).
@@ -870,6 +870,7 @@ Due to the format of the Email object, when creating an Email there are a number
     given, it may be included but is ignored by the server (the size is
     actually calculated from the blob content itself).
   - A `Content-Transfer-Encoding` header field MUST NOT be given.
+  - <aside>EmailBodyPart specific headers are not supported for Email/set create. </aside>
 - Within an EmailBodyValue object, isEncodingProblem and isTruncated MUST be
   either `false` or omitted.
 


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