Naming conventions for email objects

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

HCP handles email objects the same way it handles other objects, except that for email stored through SMTP, HCP automatically generates directory paths and object names. It generates the paths directly under a parent directory that’s specified in the namespace configuration. To learn the parent directory path, contact your tenant administrator.

Email directory and object names

The generated path and object name for email stored using SMTP consists of, in order:

  • The email path specified in the namespace configuration, ending with a forward slash (/):

    Example: /email/

  • A system-generated numeric ID followed by a forward slash (/):

    Example: 341/

  • The date and time the email was stored, in this format, followed by a hyphen (-):

    year/month/day/hour/minute/hour-minute-second.millisecond

    Example: 2013/03/02/02/47/02-47-22.186-

  • An internally generated message ID followed by a hyphen:

    Example: 1D34A84A-

  • A repeat of the system-generated numeric ID followed by a hyphen:

    Example: 341-

  • A counter to ensure that all objects stored in the same millisecond have unique names followed by an at sign (@):

    Example: 0@

  • The domain name of the sender contained in the From field of the mail header, followed by a hyphen (-):

    Example: example.com-

  • The email suffix specified in the namespace configuration:

    Example: mbox.eml

Here’s the complete path and object name for a sample email message:

/rest/email/341/2013/03/02/02/47/02-47-22.186-1D34A84A-341-0@example.com-mbox.eml

The message ID that the mail server generates for an email ingested through the SMTP protocol can include one or more forward slashes (/) or colons (:). Before storing an email, HCP replaces each such slash or colon with a hyphen (-).

Email attachments

The namespace can be configured to store each email together with or separately from its attachments, if any. When stored together, the result is the single email object named as described above.

When stored separately, each attachment is in the same directory as the email object. The name of the attachment object is formed from the name of the email object (without the suffix) concatenated with a hyphen (-) and the name of the attached file.

Here’s an example of the complete path and object names that result from storing two attachments separately from the email with which they arrive:

  • Email:
    /rest/email/365/2013/03/02/17/12/17-12-29.522-4FE72776-365-0@example.com-mbox.eml
  • First attachment:
    /rest/email/365/2013/03/02/17/12/17-12-29.522-4FE72776-365-0@example.com-Wetlands Guidelines 2011-10-01.pdf
  • Second attachment:
    /rest/email/365/2013/03/02/17/12/17-12-29.522-4FE72776-365-0@example.com-Anytown-Lot53645-A.jpg