PostMailDto
Type Alias: PostMailDto
[object Object]
Defined in: app/api/types.gen.ts:766
Defines the DTO for posting a mail, containing the necessary information for creating a new mail, including its subject, HTML content, and recipients. The PostMailDTO is used to transfer data from the client to the server when creating a new mail, ensuring that all required information is provided and validated appropriately for the creation process. The PostMailDTO allows for the specification of multiple recipients for the mail, enabling effective communication with multiple individuals or groups based on the provided recipient information in the request payload. The recipients can be specified using the MailRecipient class, which includes properties such as the recipient's email address and name, allowing for personalized and targeted communication through email based on the specified recipient details. The PostMailDTO ensures that the mail is created with the necessary information to effectively communicate the intended message to the specified recipients, providing a structured and validated approach to mail creation in the application.
Properties
htmlContent
[object Object]
Defined in: app/api/types.gen.ts:774
The HTML content of the mail to be sent. This field is required to provide the actual body of the email in HTML format, allowing for rich formatting and presentation of the mail content. The HTML content can include various elements such as text, images, links, and other formatting options to enhance the visual appeal and readability of the email, ensuring that the message is effectively communicated to the recipients based on the specified content and formatting. The HTML content should be well-structured and properly formatted to ensure that it renders correctly in different email clients and devices, providing a consistent and engaging experience for the recipients of the mail.
recipients
[object Object]
Defined in: app/api/types.gen.ts:778
The recipients of the mail to be sent. This field is required to specify the individuals or groups who will receive the email, allowing for effective communication with the intended audience based on the provided recipient information in the request payload. The recipients can be specified using the MailRecipient class, which includes properties such as the recipient's email address and name, enabling personalized and targeted communication through email based on the specified recipient details. The recipients field should contain valid email addresses and relevant recipient information to ensure that the mail is delivered successfully to the intended recipients and that the communication is effective and meaningful based on the provided recipient data in the request payload.
subject
[object Object]
Defined in: app/api/types.gen.ts:770
The subject of the mail to be sent. This field is required to provide a clear and concise subject line for the email, allowing recipients to understand the purpose and content of the mail at a glance. The subject should be relevant to the content of the mail and should effectively convey the main message or topic being communicated in the email.