Skip to content
Cloudflare API
Start here
API Reference
Email Security
Investigate
Move

Move multiple messages

email_security.investigate.move.bulk(MoveBulkParams**kwargs) -> SyncSinglePage[MoveBulkResponse]
POST/accounts/{account_id}/email-security/investigate/move

Maximum batch size: 1000 messages per request

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Cloud Email Security: Write
ParametersExpand Collapse
account_id: str

Account Identifier

maxLength32
minLength32
destination: Literal["Inbox", "JunkEmail", "DeletedItems", 2 more]
One of the following:
"Inbox"
"JunkEmail"
"DeletedItems"
"RecoverableItemsDeletions"
"RecoverableItemsPurges"
ids: Optional[Sequence[str]]

List of message IDs to move.

Deprecatedpostfix_ids: Optional[Sequence[str]]

Deprecated: Use ids instead. List of message IDs to move.

ReturnsExpand Collapse
class MoveBulkResponse: …
Deprecatedcompleted_timestamp: datetime

Deprecated, use completed_at instead

formatdate-time
Deprecateditem_count: int
formatint32
success: bool
completed_at: Optional[datetime]
formatdate-time
destination: Optional[str]
message_id: Optional[str]
operation: Optional[str]
recipient: Optional[str]
status: Optional[str]

Move multiple messages

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.email_security.investigate.move.bulk(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    destination="Inbox",
)
page = page.result[0]
print(page.message_id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "completed_timestamp": "2019-12-27T18:11:19.117Z",
      "item_count": 0,
      "success": true,
      "completed_at": "2019-12-27T18:11:19.117Z",
      "destination": "destination",
      "message_id": "message_id",
      "operation": "operation",
      "recipient": "recipient",
      "status": "status"
    }
  ],
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "completed_timestamp": "2019-12-27T18:11:19.117Z",
      "item_count": 0,
      "success": true,
      "completed_at": "2019-12-27T18:11:19.117Z",
      "destination": "destination",
      "message_id": "message_id",
      "operation": "operation",
      "recipient": "recipient",
      "status": "status"
    }
  ],
  "success": true
}