Arlo

REST Auth API: Attachments

Attachment resources are a subresource of MailMessages and describe an attachment to the mail message.

Attachment instance resource

General structure

This resource contains a list of Attachment elements, each representing a different attachment on the owning MailMessage.

<Attachments>
  <Attachment>
    <Name>Invoice-C07123.pdf</Name>
    <ContentType>application/x-pdf</ContentType>
    <SizeBytes>1024768</SizeBytes>
    <!-- Used on POST only -->
    <ContentEncoding>Base64</ContentEncoding>
    <Content>
      hX6VYoTG6n+suzKhPl35rI+Bsef8FwVKDYlzEJ2i5HLKa38SLLrE9bW9jViSR1PJGsDmNOEgWu+6
      HdYm9SsRDcvDlZAdMXAiHBmq6BZXnj0w87YbdMnB0e2fyUY6ZkiHw+A0oNWCnJLME9/6vJUGsnPL
      TEw4YI0fX5ZUvItt0skSSmI5EhaZn09gWEBKRjXVoGCOWVlXbOURkOcbemhsF1pGsRE2WKiOSvsr
      Xj/5swkAA5csea1TW5mQ1qe7GBls6QBYapkxEMmJxXvatxFWjHVT3lKV0YVR3SI2CxOBePUgWxiL
      ZkQccl+PGBWmkD7vW62bu1Lkp8edf7R/E653pi+e4WjLkN2wKl1uBbRroFsT71NzNBalvR/ZkFaa
      2I04koI49ijYuqNojN5PoutNAVijyJDA9xMn1Z5UTdUB7LNerWiU64fUl+cgCC1g+nU2IOH7MEbv
      gT0Mr5V+XAeLJUJSkFmxqg75U+mnUkpFF2dJiWivjvnuFO+khdjbVYNMD11n4fCQvN9AywzH23uo
      03iOY1uv27ENeBfieFxiRwFfEkPDgTyIL3W6zgL0MEvxetk5kc0EJTlhvin7PwD/BtosN2dlfPvw
      cjTKbdf43fru+WnFknH4cQq1LzN/foZqp+4FmoLjCvda21+Ckediz5mOhl0Gzuof8AuDFvReF5OU
    </Content>
    <!-- For persisted messages -->
    <Link rel="" type="application/x-pdf" title="Content" href="https://s3.amazonaws.com/foo/" />
  </Attachment>
</Attachments>

Attachment Resource properties

Property Description
Name The name provided for the attachment.
ContentType The MIME type encoding for content.
SizeBytes The size of the attachment.
ContentEncoding This field is to be provided only on POST requests, it details the encoding used on the provided content block.
Content This field is to be provided only on POST requests, it is the encoded content of the attachment.

HTTP GET

Not supported.

HTTP POST

Not supported - see the ArchivedMessages resource for details on how to POST Attachment resources as part of POST to the ArchivedMessages endpoint.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.