> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IScheduledMailBase

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Deprecated
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/dashboard/scheduledMail.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

> Warning: This API is now obsolete.
> 
> - use [IAutomationMetadataObjectBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md) instead
> 

A scheduled email common properties

**Signature:**

```typescript
export interface IScheduledMailBase 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [attachments](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbaseattachments) |  | [ScheduledMailAttachment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.scheduledmailattachment/index.md)[] | **_(ALPHA)_** Email attachments |
| [bcc?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasebcc) |  | string[] | **_(ALPHA)_** _(Optional)_ BCC recipients email addresses |
| [body](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasebody) |  | string | **_(ALPHA)_** Email message body |
| [description](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasedescription) |  | string | **_(ALPHA)_** Scheduled email description |
| [lastSuccessful?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbaselastsuccessful) |  | string | **_(ALPHA)_** _(Optional)_ Date of the last successful email processing job run |
| [subject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasesubject) |  | string | **_(ALPHA)_** Email subject |
| [title](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasetitle) |  | string | **_(ALPHA)_** Scheduled email title |
| [to](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbaseto) |  | string[] | **_(ALPHA)_** Recipients unique login identifiers - should be equal to login property in [IWorkspaceUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceuser/index.md) / [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) |
| [unlisted](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbaseunlisted) |  | boolean | **_(ALPHA)_** Is unlisted? |
| [unsubscribed?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbaseunsubscribed) |  | string[] | **_(ALPHA)_** _(Optional)_ Unsubscribed recipients email addresses |
| [when](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmailbase/index.md#ischeduledmailbasewhen) |  | { startDate: string; endDate?: string; recurrence: string; timeZone: string; } | **_(ALPHA)_** Scheduled email job interval |

## Property details

### IScheduledMailBase.attachments

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Email attachments

**Signature:**

```typescript
attachments: ScheduledMailAttachment[];
```

### IScheduledMailBase.bcc

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

BCC recipients email addresses

**Signature:**

```typescript
bcc?: string[];
```

### IScheduledMailBase.body

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Email message body

**Signature:**

```typescript
body: string;
```

### IScheduledMailBase.description

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Scheduled email description

**Signature:**

```typescript
description: string;
```

### IScheduledMailBase.lastSuccessful

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Date of the last successful email processing job run

**Signature:**

```typescript
lastSuccessful?: string;
```

### IScheduledMailBase.subject

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Email subject

**Signature:**

```typescript
subject: string;
```

### IScheduledMailBase.title

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Scheduled email title

**Signature:**

```typescript
title: string;
```

### IScheduledMailBase.to

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Recipients unique login identifiers - should be equal to login property in [IWorkspaceUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceuser/index.md) / [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md)

**Signature:**

```typescript
to: string[];
```

### IScheduledMailBase.unlisted

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is unlisted?

**Signature:**

```typescript
unlisted: boolean;
```

### IScheduledMailBase.unsubscribed

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Unsubscribed recipients email addresses

**Signature:**

```typescript
unsubscribed?: string[];
```

### IScheduledMailBase.when

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Scheduled email job interval

**Signature:**

```typescript
when: {
        startDate: string;
        endDate?: string;
        recurrence: string;
        timeZone: string;
    };
```