Update a Message

Updates the Message resource. For example, mark a message as read or flagged.

smtppy.updatemessage(accountId, mailboxId, id, expiresAt, isRead, isFlagged, autoDeleteEnabled

Parameters

  • isRead (boo) - Set to true to mark the message as read

  • mailboxId (string) (required) - The mailbox identifier.

  • id (string) (required) - The message identifier.

Response

{
  "id": "string",
  "msgid": "string",
  "from": {
    "name": "string",
    "address": "string"
  },
  "to": [
    {
      "name": "string",
      "address": "string"
    }
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "subject": "string",
  "isRead": true,
  "isFlagged": true,
  "verifications": [
    "string"
  ],
  "autoDeleteEnabled": true,
  "expiresAt": "2025-04-01T00:00:00.000Z",
  "text": "string",
  "html": [
    "string"
  ],
  "hasAttachments": true,
  "attachments": [
    {
      "id": "string",
      "filename": "string",
      "contentType": "string",
      "disposition": "string",
      "transferEncoding": "string",
      "related": true,
      "size": 0,
      "downloadUrl": "string"
    }
  ],
  "size": 0,
  "downloadUrl": "string",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z"
}

Want to learn about writing content from scratch? Head to the Basics section to learn more.

Last updated