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

# useDashboardScheduledEmails()

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: function
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/react/useDasboardScheduledEmails/useDashboardScheduledEmails.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).
> 

Hook that handles schedule emailing dialogs.

**Signature:**

```typescript
useDashboardScheduledEmails: () => {
    scheduledExportToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined;
    isInitialized: boolean;
    notificationChannels: import("@gooddata/sdk-model").INotificationChannelIdentifier[];
    automations: import("@gooddata/sdk-model").IAutomationMetadataObject[];
    automationsCount: number;
    numberOfAvailableDestinations: number;
    widget: import("../../types/layoutTypes.js").ICustomWidget | import("@gooddata/sdk-model").IWidget | undefined;
    insight: import("@gooddata/sdk-model").IInsight | undefined;
    automationsLoading: boolean;
    automationsError: import("@gooddata/sdk-ui").GoodDataSdkError | undefined;
    isScheduledEmailingVisible: boolean;
    isScheduleEmailingDialogOpen: boolean;
    defaultOnScheduleEmailing: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingCancel: (_widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingBack: (_widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingCreateError: () => void;
    onScheduleEmailingCreateSuccess: (scheduledEmail: import("@gooddata/sdk-model").IAutomationMetadataObject) => void;
    onScheduleEmailingUpdateError: () => void;
    onScheduleEmailingUpdateSuccess: () => void;
    isScheduledManagementEmailingVisible: boolean;
    isScheduleEmailingManagementDialogOpen: boolean;
    defaultOnScheduleEmailingManagement: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementEdit: (schedule: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementClose: () => void;
    onScheduleEmailingManagementLoadingError: () => void;
    onScheduleEmailingDeleteSuccess: () => void;
    onScheduleEmailingDeleteError: () => void;
}
```
**Returns:**

{ scheduledExportToEdit: import("@gooddata/sdk-model").[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) &#124; undefined; isInitialized: boolean; notificationChannels: import("@gooddata/sdk-model").[INotificationChannelIdentifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelidentifier/index.md)[]; automations: import("@gooddata/sdk-model").[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)[]; automationsCount: number; numberOfAvailableDestinations: number; widget: import("../../types/layoutTypes.js").[ICustomWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icustomwidget/index.md) &#124; import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) &#124; undefined; insight: import("@gooddata/sdk-model").[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) &#124; undefined; automationsLoading: boolean; automationsError: import("@gooddata/sdk-ui").[GoodDataSdkError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.gooddatasdkerror/index.md) &#124; undefined; isScheduledEmailingVisible: boolean; isScheduleEmailingDialogOpen: boolean; defaultOnScheduleEmailing: (widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingOpen: (widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingCancel: (\_widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingBack: (\_widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingCreateError: () =&gt; void; onScheduleEmailingCreateSuccess: (scheduledEmail: import("@gooddata/sdk-model").[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)) =&gt; void; onScheduleEmailingUpdateError: () =&gt; void; onScheduleEmailingUpdateSuccess: () =&gt; void; isScheduledManagementEmailingVisible: boolean; isScheduleEmailingManagementDialogOpen: boolean; defaultOnScheduleEmailingManagement: (widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingManagementOpen: (widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingManagementEdit: (schedule: import("@gooddata/sdk-model").[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md), widget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").[IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md)) =&gt; void; onScheduleEmailingManagementClose: () =&gt; void; onScheduleEmailingManagementLoadingError: () =&gt; void; onScheduleEmailingDeleteSuccess: () =&gt; void; onScheduleEmailingDeleteError: () =&gt; void; }
