Skip to content

Archiving

Archived mailboxes are mailboxes that were created with recoverable=true and have expired. They can be reactivated to restore the same email address.

List all archived mailboxes for your account.

Response (200 OK):

{
"items": [
{
"id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"alias": "cdvk6fxequwd",
"domain": "minutemail.cc",
"tag": "newsletter",
"owner": "user_123abc",
"createdAt": "2024-01-17T00:00:00Z"
}
]
}

Response Fields:

FieldTypeDescription
idstringUnique archived mailbox identifier
aliasstringOriginal mailbox alias
domainstringOriginal mailbox domain
tagstringTag for organization
ownerstringUser ID of the mailbox owner
createdAtstringISO 8601 timestamp when originally created

Status Codes:

  • 200 OK: Success
  • 401 Unauthorized: Invalid or missing API key

Example:

Terminal window
curl https://api.minutemail.co/v1/archived-mailboxes \
-H "Authorization: Bearer mmak_FKI5IKBJ4FSZJLUFGJ3IMF4A55W2OZW7YMLWD3JI33IVUGDEJXLQ"

GET /v1/archived-mailboxes/{archivedMailboxId}

Section titled “GET /v1/archived-mailboxes/{archivedMailboxId}”

Retrieve details of a specific archived mailbox.

Path Parameters:

ParameterTypeDescription
archivedMailboxIdstringArchived mailbox identifier

Response (200 OK):

{
"id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"alias": "cdvk6fxequwd",
"domain": "minutemail.cc",
"tag": "newsletter",
"owner": "user_123abc",
"createdAt": "2024-01-17T00:00:00Z"
}

Status Codes:

  • 200 OK: Success
  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden: You don’t have access to this archived mailbox
  • 404 Not Found: Archived mailbox not found

Example:

Terminal window
curl https://api.minutemail.co/v1/archived-mailboxes/a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d \
-H "Authorization: Bearer mmak_FKI5IKBJ4FSZJLUFGJ3IMF4A55W2OZW7YMLWD3JI33IVUGDEJXLQ"

POST /v1/archived-mailboxes/{archivedMailboxId}/reactivate

Section titled “POST /v1/archived-mailboxes/{archivedMailboxId}/reactivate”

Reactivate an archived mailbox with the same email address.

Path Parameters:

ParameterTypeDescription
archivedMailboxIdstringArchived mailbox identifier

Request Body:

{
"expiresIn": 30
}

Parameters:

FieldTypeDescriptionRequired
expiresInintegerLifetime in minutes (1-60) for reactivated mailboxNo

Response (201 Created):

{
"id": "ed930b25-dd40-41b3-a712-e502fbcc5565",
"alias": "cdvk6fxequwd",
"domain": "minutemail.cc",
"address": "cdvk6fxequwd@minutemail.cc",
"recoverable": true,
"tag": "newsletter",
"owner": "user_123abc",
"messageCount": 0,
"expiresAt": "2024-01-18T01:00:00Z",
"createdAt": "2024-01-18T00:00:00Z"
}

Status Codes:

  • 201 Created: Mailbox reactivated successfully
  • 400 Bad Request: Invalid duration format
  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden: You don’t have access to this archived mailbox
  • 404 Not Found: Archived mailbox not found
  • 409 Conflict: Email address is already in use (alias conflict)
  • 429 Too Many Requests: Active mailbox quota exceeded

Example:

Terminal window
curl -X POST https://api.minutemail.co/v1/archived-mailboxes/a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d/reactivate \
-H "Authorization: Bearer mmak_FKI5IKBJ4FSZJLUFGJ3IMF4A55W2OZW7YMLWD3JI33IVUGDEJXLQ" \
-H "Content-Type: application/json" \
-d '{"expiresIn": 30}'

Permanently delete multiple archived mailboxes in a single request. This action cannot be undone.

Request Body:

{
"ids": [
"a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"b2c3d4e5-f6a7-5432-9876-1234567890ab",
"c3d4e5f6-a7b8-6543-0987-234567890abc"
]
}

Parameters:

FieldTypeDescriptionRequired
idsarray[string]Array of archived mailbox identifiers to deleteYes

Response: No content

Status Codes:

  • 204 No Content: All archived mailboxes successfully deleted
  • 400 Bad Request: Invalid input (empty ids array, invalid format)
  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden: You don’t have permission to delete one or more archived mailboxes
  • 404 Not Found: One or more archived mailboxes not found

Notes:

  • All archived mailboxes are validated for permissions before any deletion occurs
  • If any validation fails, the entire operation is rejected (atomic)
  • This is a permanent deletion - archived mailboxes cannot be recovered

Example:

Terminal window
curl -X DELETE https://api.minutemail.co/v1/archived-mailboxes \
-H "Authorization: Bearer mmak_FKI5IKBJ4FSZJLUFGJ3IMF4A55W2OZW7YMLWD3JI33IVUGDEJXLQ" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"b2c3d4e5-f6a7-5432-9876-1234567890ab"
]
}'

DELETE /v1/archived-mailboxes/{archivedMailboxId}

Section titled “DELETE /v1/archived-mailboxes/{archivedMailboxId}”

Permanently delete an archived mailbox. This action cannot be undone.

Path Parameters:

ParameterTypeDescription
archivedMailboxIdstringArchived mailbox identifier

Response: No content

Status Codes:

  • 204 No Content: Successfully deleted
  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden: You don’t have access to this archived mailbox
  • 404 Not Found: Archived mailbox not found

Example:

Terminal window
curl -X DELETE https://api.minutemail.co/v1/archived-mailboxes/a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d \
-H "Authorization: Bearer mmak_FKI5IKBJ4FSZJLUFGJ3IMF4A55W2OZW7YMLWD3JI33IVUGDEJXLQ"