REST Auth API: MailMessages
MailMessage resources are a subresource of ArchivedMessages and describe the contents of an email message.
MailMessage instance resource
General structure
<MailMessage>
<To>
<Address>Jordan Mechner <jordan.mechner@example.org></Address>
</To>
<CC>
<Address>Jordan Mechner <jordan.mechner@example.org></Address>
</CC>
<Bcc>
<Address>Jordan Mechner <jordan.mechner@example.org></Address>
</Bcc>
<Subject>My test message</Subject>
<ReplyTo>
<Address>Jordan Mechner <jordan.mechner@example.org></Address>
</ReplyTo>
<From>Jordan Mechner <jordan.mechner@example.org></From>
<Body>
<View>
<ContentType>text/html</ContentType>
<Content>
<p>Please find attached your invoice.</p>
</Content>
</View>
<View>
<ContentType>text/plain</ContentType>
<Content>
Please find attached your invoice.
</Content>
</View>
</Body>
<Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/archivedmailmessages/562/mailmessage/attachments"/>
<Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Attachments" type="application/xml" title="Attachments" href="https://demo.arlo.co/api/2012-02-01/auth/resources/archivedmailmessages/562/mailmessage/attachments"/>
</MailMessage>
Resource properties
| Property | Description |
|---|---|
| To |
Contains <Address> elements each containing a SMTP Address which the email was sent To. Each address element can be a single address jordan.mechner@example.org or a name and an address in the format Jordan Mechner <jordan.mechner@example.org>.
|
| CC |
Contains <Address> elements each containing a SMTP Address which the email was CC'ed to. See To for more details.
|
| Bcc |
Contains <Address> elements each containing a SMTP Address which the email was BCC'ed to. See To for more details.
|
| Subject | A string containing the subject of the message, up to 512 characters long. |
| ReplyTo |
Contains <Address> elements each containing a SMTP Address to be used as the reply to addresses. See To for more details.
|
| From |
Contains an <Address> element containing the SMTP Address to be used as the sender. See To for more details.
|
| Body | Describes the body content through one or more <View> elements. |
| Body/View | Describes the message body in a given format. |
| Body/View/ContentType | The MIME type encoding for view. |
| Body/View/Content | The content for the view. |
Related resource links
| Link (title) | Description |
|---|---|
| Attachments |
Reference to Attachments associated with this MailMessage.
|
HTTP GET
Not supported.
HTTP POST
Not supported - see the ArchivedMessages resource for details on how to POST MailMessage resources as part of POST to the ArchivedMessages endpoint.
HTTP PUT
Not supported.
HTTP DELETE
Not supported.
