Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add emails REST API doc. #211

Open
wants to merge 4 commits into
base: 5.x
Choose a base branch
from

Conversation

abhisekmazumdar
Copy link
Member

PR covers the following:

@abhisekmazumdar
Copy link
Member Author

abhisekmazumdar commented Sep 3, 2024

I have tried to the best of my knowledge to convert the Markdown to rst.

I will add a commits to this PR, which will just have the updates based on mautic/mautic#13775

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @abhisekmazumdar thanks so much for bringing this content over to the developer docs, huge appreciation!

I've made a few comments but there's some things you should tweak for all occurrences and I didn't want to flood the PR with all the recommended changes, so here they are:

When referring to an Email in Mautic, use the capital letter. Only lower case if you're mentioning the act of sending an email or referring to email address, for example.

Please enclose any code snippets or references in either inline code (double backticks) or a code block - in the table each subject should be annotated like this (I've given some examples).

In some cases the content seems to be breaking onto two lines, I don't know how that will render but it's worth looking at whether that has any impact (I haven't built the docs locally to check at this point).

All headings need to be unique, because they generate their URLs and cross-linking snippets from the title. If we can't put that in the actual header - I noticed you're using custom anchors in some places - let's make those anchors relevant to the thing we're describing (e.g. _http-request-get-emails rather than _http-request-1). It makes it much easier for someone reading through the code to know what it's referring to.

It's also helpful to use contractions - don't rather than do not - Vale will pick up more recommendations as you type. If you need help getting set up with Vale in your IDE so that it can hint as you type, let us know - this repo should initialise it for VSCode users with all the plugins, I think.

Thanks again for bringing this over, we desperately want to finish this content migration so we can finally close down developer.mautic.org so we really appreciate your help with this!

Emails
######

Use this endpoint to obtain details, create, update or delete Mautic’s
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use this endpoint to obtain details, create, update or delete Mautic’s
Use this endpoint to obtain details, create, update, or delete Mautic’s

Vale fix (oxford comma)

######

Use this endpoint to obtain details, create, update or delete Mautic’s
emails.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
emails.
Emails.

}
}

Get an individual email by ID.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Get an individual email by ID.
Get an individual Email by ID.


Get an individual email by ID.

HTTP Request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
HTTP Request
HTTP request

+--------------+--------------+----------------------------------------+
| Name | Type | Description |
+==============+==============+========================================+
| id | int | ID of the email |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| id | int | ID of the email |
| id | int | ID of the Email |

| | | the one in the Mautic configuration |
+--------------+--------------+----------------------------------------+
| re | string | The reply to email address if it’s |
| plyToAddress | | different than the one in the Mautic |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pop this in double backticks, I don't know why GitHub Is breaking it over two lines.

| plyToAddress | | different than the one in the Mautic |
| | | configuration |
+--------------+--------------+----------------------------------------+
| bccAddress | string | The BCC email address if it’s |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| bccAddress | string | The BCC email address if it’s |
| ``bccAddress`` | string | The BCC email address if it’s |

| | | different than the one in the Mautic |
| | | configuration |
+--------------+--------------+----------------------------------------+
| isPublished | bool | Published state |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| isPublished | bool | Published state |
| ``isPublished`` | boolean | Published state |

I think it should be the full term, boolean?

+--------------+--------------+----------------------------------------+
| isPublished | bool | Published state |
+--------------+--------------+----------------------------------------+
| publishUp | d | Date/time when the email should be |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| publishUp | d | Date/time when the email should be |
| ``publishUp`` | d | Date/time when the email should be |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also check the wording here - we changed all the states from Published to Active or Available, so we might also need to update it here.

| publishUp | d | Date/time when the email should be |
| | atetime/null | published |
+--------------+--------------+----------------------------------------+
| publishDown | d | Date/time the email should be un |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| publishDown | d | Date/time the email should be un |
| ``publishDown`` | d | Date/time the email should be un |

@abhisekmazumdar abhisekmazumdar changed the title Add emails REST API doc. WIP: Add emails REST API doc. Sep 10, 2024
@abhisekmazumdar
Copy link
Member Author

I tried to make the suggested changes and also added the grapesjsbuilder >> customMjml into the tables.
I still see value is complicating few other places. Will try to have a look at it again.

@abhisekmazumdar abhisekmazumdar changed the title WIP: Add emails REST API doc. Add emails REST API doc. Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants