Lodol Docs

Yahoo Mail

API actions for the Yahoo Mail integration.

Yahoo Mail

Read and send emails using Yahoo Mail's REST API.


Delete message

Delete a message by ID.

Parameters

ParameterTypeRequiredDescription
message_idstringYes

Response

{}

Get message

Retrieve message metadata and body by ID.

Parameters

ParameterTypeRequiredDescription
message_idstringYes

Response

{
  "result": {
    "body": {
      "html": "example_value",
      "text": "Sample text content"
    },
    "date": "2024-01-15T10:30:00Z",
    "from": "example_value",
    "id": "abc123xyz789",
    "isRead": false,
    "subject": "example_value",
    "to": [
      "mock_value"
    ]
  }
}

List messages

List messages in a folder with pagination.

Parameters

ParameterTypeRequiredDescription
folderstringNo
limitnumberNo
cursorstringNo

Response

{
  "result": {
    "cursor": "example_value",
    "messages": [
      {
        "date": "2024-01-15T10:30:00Z",
        "from": "example_value",
        "id": "abc123xyz789",
        "isRead": false,
        "subject": "example_value"
      }
    ]
  }
}

Mark message as read

Mark a message as read.

Parameters

ParameterTypeRequiredDescription
message_idstringYes

Response

{
  "result": {
    "marked_read": true,
    "message_id": "abc123xyz789"
  }
}

Move message

Move a message to a different folder.

Parameters

ParameterTypeRequiredDescription
message_idstringYes
destination_folderstringYes

Response

{
  "result": {
    "destination_folder": "Documents",
    "message_id": "abc123xyz789",
    "moved": true
  }
}

Search messages

Search messages with a query string.

Parameters

ParameterTypeRequiredDescription
querystringYes
limitnumberNo

Response

{
  "result": {
    "messages": [
      {
        "date": "2024-01-15T10:30:00Z",
        "from": "example_value",
        "id": "abc123xyz789",
        "subject": "example_value"
      }
    ]
  }
}

Send an email

Send a plain text or HTML email through Yahoo Mail.

Parameters

ParameterTypeRequiredDescription
tostringYesRecipient email address or comma-separated list
subjectstringYesSubject line for the email
body_textstringYesPlain text body content
body_htmlstringNoHTML body content
ccstringNo
bccstringNo

Response

{
  "result": {
    "message_id": "abc123xyz789",
    "sent": true
  }
}

On this page