Problem/Motivation

Email is such a standard part of the repertoire of customer support communication, it's well over the 90% use case.

So let's add an OOTB box email declaration and evidence type.

Proposed resolution

I suggest 3 fields:
(1) field_email_charity 'Email of the charity' 'The email address where the charity received the message.'. Required.
(2) field_email_donor 'Email of the donor' The email address that sent the message to the charity'. Not required.
(3) field_text. 'Email text' The text of the email(s) exchanged with the donor. Required.

Comments

jonathanshaw created an issue. See original summary.

adamps’s picture

Assigned: Unassigned » jonathanshaw
Status: Active » Needs review

With 2 new types and 3 fields each, plus view and display settings this will generate 12 files. It's quite fiddly to get them to work correctly because after exporting the config I have to edit out parts that are specific to my site, and parts that represent base fields. It's tricky to test because it might work for me, but only because I have some setting that I failed to export or edit correctly.

I agree that email is standard. But I'm less sure that there will be agreement on how to represent it. Should we record the subject? What about the date? You mention the possibility of multiple emails, so that suggests multiple dates/subjects? Even the from/to email addresses might differ per email. So perhaps separate evidence for each email will work better? Is the body a plain text field or formatted? Might we prefer to save the email as an eml file (which seems much more convincing evidence IMO)? Or even export it as a PDF (which is already possible)? If the charity only has one email address, should that field really be mandatory?

jonathanshaw’s picture

But I'm less sure that there will be agreement on how to represent it.

Agreed. It's thorny.

I'm quite tempted to abandon it. The things that pricks my conscience is that a lot of cancellations will be email, but cancellation is the kind of boring thing that people don't want to optimise. It'd be nice if it just worked well enough OOTB.

Should we record the subject? What about the date? You mention the possibility of multiple emails, so that suggests multiple dates/subjects? Even the from/to email addresses might differ per email. So perhaps separate evidence for each email will work better? Is the body a plain text field or formatted? Might we prefer to save the email as an eml file (which seems much more convincing evidence IMO)? Or even export it as a PDF (which is already possible)? If the charity only has one email address, should that field really be mandatory?

I keep prevaricating. I will get back to you.

For evidence type: let's call it 'Email message file' and have a multivalue file field accepting .eml and .msg
People can make a seperate evidence type for less forensically robust evidence if they want.

For declaration type:

jonathanshaw’s picture

This is complicated by the fact that I'm suggesting evidence of email confirmation in #3537036: Written confirmation.

adamps’s picture

This is complicated by the fact that I'm suggesting evidence of email confirmation in #3537036: Written confirmation.

I feel that the Written confirmation case is separate. We already have two cases where we programmatically create evidence. They use an evidence type and fields that are locked, so they can't be deleted, and this type is not available to staff or admins. We should do the same. It keeps the customisable settings nice and separate from the config that the module depends on.

If this is primarily for cancellations then we need an evidence type but potentially not a declaration type so already that would cut the development time.

jonathanshaw’s picture

We already have two cases where we programmatically create evidence. They use an evidence type and fields that are locked, so they can't be deleted, and this type is not available to staff or admins. We should do the same. It keeps the customisable settings nice and separate from the config that the module depends on.

Ah good! I was wondering about exactly that. This helps a lot.

jonathanshaw’s picture

Assigned: jonathanshaw » Unassigned
Status: Needs review » Needs work

OK. The point is to make something that is good enough to support the unglamous but necessary admin work of cancellation without having to be designed carefully by sitebuilders in advance. So let's aim for breadth of relevance combined with relative simplicity:
(1) field_charity_email 'Email of the charity' 'The email address where the charity received the message.'.
(2) field_donor_email 'Email of the donor' The email address that sent the message to the charity'.
(3) field_text. 'Email text' The text of the email(s) exchanged with the donor.
(4) field_file 'File' A file containing a record of the email(s). Multivalue file field, allows eml, msg, txt, pdf, jpg, jpeg, png, webp. [Yes this duplicates other evidence types, but sometimes you might want to record the to/from email addresses alongside a screenshot that doesn't capture that info.]
No fields are required, all are visible by default on the form.

This makes a solid base that should be good enough for almost any site to use OOTB, doesn't force awkward choices on staff, while easy for sites to streamline if they want to be particular about how emails are recorded.

Maybe there's a better way of handling this, but I can't figure it out and this seems good enough.

adamps’s picture

I feel it's easy to speculate but end up with something not very useful. And it's fairly time-consuming to change.

How about if you create the declaration/evidence types that you want on your own sites, and try them out for a while in real operation? Then we can take a look if you have ended up with something worth exporting then committing for general reuse.