dev/email plugin docs update

[stb13579]

What does it do?

• Update the email plugin documentation to match the docs style.
• Add more complete examples to the documentation.

Why is it needed?

Describe the issue you are solving.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
documentation	✅ Ready (Inspect)	Visit Preview	Jul 11, 2022 at 11:22AM (UTC)

[pwizla]

Thanks, Shaun. I've added some comments and questions.

On top of that, I think some of the questions or concerns that were raised in the first round of reviews were not handled, but I can't see check as they were already marked as resolved. For further reviews or next PRs, could you please reply directly to comments? It will be easier to follow up.

[pwizla]

data seems optional (I can't find it in the code example, maybe I misunderstood something 🤔) so I think you can mention it in the table (e.g. "data
(optional)"
The intro paragraph implies that emailOptions is optional as well, but is it? I'm trying to figure out how the email is sent if neither to or from parameters are defined (just an open question) 🤔

[stb13579]

Added "optional" to the table.

I think the answer is because you can also hard code the email address information. Here the source code, which as I understand, only throws an error is emailTemplate is not supplied.

  const attributes = ['subject', 'text', 'html'];
  const missingAttributes = _.difference(attributes, Object.keys(emailTemplate));
  if (missingAttributes.length > 0) {
    throw new Error(
      `Following attributes are missing from your email template : ${missingAttributes.join(', ')}`
    );
  }```

[pwizla]

I think it would be worth adding a table here, for the parameters.
Generally, the structure of this kind of subsection is:

1. little introduction to get the context and understand what the described product item does
2. more details if necessary (here, parameters — we need to know which are optional, for instance, and the accepted types for each parameter)
3. an example (code example in dev docs, usually)

[stb13579]

table added. and sentence added to the paragraph.

[stb13579]

Thanks, Shaun. I've added some comments and questions.

On top of that, I think some of the questions or concerns that were raised in the first round of reviews were not handled, but I can't see check as they were already marked as resolved. For further reviews or next PRs, could you please reply directly to comments? It will be easier to follow up.

I went back and commented on the earlier comments

[pwizla]

Closed in favor of #992, thank you, guys!