> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# EmailGuard: Login

> Sign in to EmailGuard with email and password to get an access token. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Sign in to EmailGuard with email and password to get an access token.

> [!NOTE]
>
> Tool ID: `emailguard_login`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'emailguard_login',
  {
    "email": "jane.doe@example.com",
    "password": "YOUR_PASSWORD"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailguard_login --input '{
  "email": "jane.doe@example.com",
  "password": "YOUR_PASSWORD"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "token": "example"
    }
  }
}
```

Use `deepline describe emailguard_login --json` for the latest machine-readable contract.

## Input reference

This endpoint allows users to authenticate by providing your login credentials (email and password). Upon successful authentication, the endpoint returns a JSON response containing the authentication token to be used for accessing protected resources.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.email` | `string` | Yes | — | Your email. |
| `payload.password` | `string` | Yes | — | Your password. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint allows users to authenticate by providing your login credentials (email and password). Upon successful authentication, the endpoint returns a JSON response containing the authentication token to be used for accessing protected resources.",
    "properties": {
      "email": {
        "type": "string",
        "description": "Your email."
      },
      "password": {
        "type": "string",
        "description": "Your password."
      }
    },
    "required": [
      "email",
      "password"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.token` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "token": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [EmailGuard provider guide](https://deepline.com/docs/providers/emailguard/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.