Interface IterableInboxCustomizations

Interface representing customizations for the Iterable Inbox.

interface IterableInboxCustomizations {
    body?: {
        color?: string;
        flexWrap?: string;
        fontSize?: number;
        paddingBottom?: number;
        width?: string;
    };
    createdAt?: { color?: string; fontSize?: number };
    messageContainer?: {
        flexDirection?: string;
        justifyContent?: string;
        paddingLeft?: number;
        width?: string;
    };
    messageRow?: {
        backgroundColor?: string;
        borderColor?: string;
        borderStyle?: string;
        borderTopWidth?: number;
        flexDirection?: string;
        height?: number;
        paddingBottom?: number;
        paddingTop?: number;
    };
    navTitle?: string;
    noMessagesBody?: string;
    noMessagesTitle?: string;
    readMessageThumbnailContainer?: {
        flexDirection?: string;
        justifyContent?: string;
        paddingLeft?: number;
    };
    title?: { fontSize?: number; paddingBottom?: number };
    unreadIndicator?: {
        backgroundColor?: string;
        borderRadius?: number;
        height?: number;
        marginLeft?: number;
        marginRight?: number;
        marginTop?: number;
        width?: number;
    };
    unreadIndicatorContainer?: {
        flexDirection?: string;
        justifyContent?: string;
    };
    unreadMessageThumbnailContainer?: {
        flexDirection?: string;
        justifyContent?: string;
        paddingLeft?: number;
    };
}

Index

Properties

body? createdAt? messageContainer? messageRow? navTitle? noMessagesBody? noMessagesTitle? readMessageThumbnailContainer? title? unreadIndicator? unreadIndicatorContainer? unreadMessageThumbnailContainer?

Properties

`Optional`body

body?: {
    color?: string;
    flexWrap?: string;
    fontSize?: number;
    paddingBottom?: number;
    width?: string;
}

The body of the message, as displayed in the inbox (not when the message has been opened).

Type Declaration

Optionalcolor?: string
The color of the body text.
OptionalflexWrap?: string
The flex wrap property of the body text.
OptionalfontSize?: number
The font size of the body text.
OptionalpaddingBottom?: number
The bottom padding of the body text.
Optionalwidth?: string
The width of the body text.

`Optional`createdAt

createdAt?: { color?: string; fontSize?: number }

The message date.

Type Declaration

Optionalcolor?: string
The color of the creation date text.
OptionalfontSize?: number
The font size of the creation date text.

`Optional`messageContainer

messageContainer?: {
    flexDirection?: string;
    justifyContent?: string;
    paddingLeft?: number;
    width?: string;
}

A container around various elements in the message item: title, body, and created at.

Type Declaration

OptionalflexDirection?: string
The flex direction of the container.
OptionaljustifyContent?: string
The justification of the container's content.
OptionalpaddingLeft?: number
The left padding of the container.
Optionalwidth?: string
The width of the container.

`Optional`messageRow

messageRow?: {
    backgroundColor?: string;
    borderColor?: string;
    borderStyle?: string;
    borderTopWidth?: number;
    flexDirection?: string;
    height?: number;
    paddingBottom?: number;
    paddingTop?: number;
}

A message row.

Use these styles to customize row height, padding, background color, border, etc.

Type Declaration

OptionalbackgroundColor?: string
The background color of the message row.
OptionalborderColor?: string
The border color of the message row.
OptionalborderStyle?: string
The border style of the message row.
OptionalborderTopWidth?: number
The top border width of the message row.
OptionalflexDirection?: string
The flex direction of the message row.
Optionalheight?: number
The height of the message row.
OptionalpaddingBottom?: number
The bottom padding of the message row.
OptionalpaddingTop?: number
The top padding of the message row.

`Optional`navTitle

navTitle?: string

The title that appears at the top of the inbox screen.

`Optional`noMessagesBody

noMessagesBody?: string

The body text that appears in the middle of the screen when the inbox contains no messages.

Default Value

"Check again later!"

`Optional`noMessagesTitle

noMessagesTitle?: string

The title that appears in the middle of the screen when the inbox contains no messages.

Default Value

"No saved messages".

`Optional`readMessageThumbnailContainer

readMessageThumbnailContainer?: {
    flexDirection?: string;
    justifyContent?: string;
    paddingLeft?: number;
}

For a read message, this is the container for the thumbnail image associated with the message (as configured when setting up the template in Iterable).

Type Declaration

OptionalflexDirection?: string
The flex direction of the container.
OptionaljustifyContent?: string
The justification of the container's content.
OptionalpaddingLeft?: number
The left padding of the container.

`Optional`title

title?: { fontSize?: number; paddingBottom?: number }

The title of the message, as displayed in the inbox.

Type Declaration

OptionalfontSize?: number
The font size of the title.
OptionalpaddingBottom?: number
The bottom padding of the title.

`Optional`unreadIndicator

unreadIndicator?: {
    backgroundColor?: string;
    borderRadius?: number;
    height?: number;
    marginLeft?: number;
    marginRight?: number;
    marginTop?: number;
    width?: number;
}

Customizations for the unread indicator icon.

Type Declaration

OptionalbackgroundColor?: string
The background color of the unread indicator.
OptionalborderRadius?: number
The border radius of the unread indicator.
Optionalheight?: number
The height of the unread indicator.
OptionalmarginLeft?: number
The left margin of the unread indicator.
OptionalmarginRight?: number
The right margin of the unread indicator.
OptionalmarginTop?: number
The top margin of the unread indicator.
Optionalwidth?: number
The width of the unread indicator.

`Optional`unreadIndicatorContainer

unreadIndicatorContainer?: { flexDirection?: string; justifyContent?: string }

CThe container that holds the unread indicator.

Type Declaration

OptionalflexDirection?: string
The flex direction of the container.
OptionaljustifyContent?: string
The justification of the container's content.

`Optional`unreadMessageThumbnailContainer

unreadMessageThumbnailContainer?: {
    flexDirection?: string;
    justifyContent?: string;
    paddingLeft?: number;
}

For an unread message, this is the container for the thumbnail image associated with the message (as configured when setting up the template in Iterable).

Type Declaration

OptionalflexDirection?: string
The flex direction of the container.
OptionaljustifyContent?: string
The justification of the container's content.
OptionalpaddingLeft?: number
The left padding of the container.

Interface IterableInboxCustomizations

Index

Properties

Properties

Optionalbody

Type Declaration

Optionalcolor?: string

OptionalflexWrap?: string

OptionalfontSize?: number

OptionalpaddingBottom?: number

Optionalwidth?: string

OptionalcreatedAt

Type Declaration

Optionalcolor?: string

OptionalfontSize?: number

OptionalmessageContainer

Type Declaration

OptionalflexDirection?: string

OptionaljustifyContent?: string

OptionalpaddingLeft?: number

Optionalwidth?: string

OptionalmessageRow

Type Declaration

OptionalbackgroundColor?: string

OptionalborderColor?: string

OptionalborderStyle?: string

OptionalborderTopWidth?: number

OptionalflexDirection?: string

Optionalheight?: number

OptionalpaddingBottom?: number

OptionalpaddingTop?: number

OptionalnavTitle

OptionalnoMessagesBody

Default Value

OptionalnoMessagesTitle

Default Value

OptionalreadMessageThumbnailContainer

Type Declaration

OptionalflexDirection?: string

OptionaljustifyContent?: string

OptionalpaddingLeft?: number

Optionaltitle

Type Declaration

OptionalfontSize?: number

OptionalpaddingBottom?: number

OptionalunreadIndicator

Type Declaration

OptionalbackgroundColor?: string

OptionalborderRadius?: number

Optionalheight?: number

OptionalmarginLeft?: number

OptionalmarginRight?: number

OptionalmarginTop?: number

Optionalwidth?: number

OptionalunreadIndicatorContainer

Type Declaration

OptionalflexDirection?: string

OptionaljustifyContent?: string

OptionalunreadMessageThumbnailContainer

Type Declaration

OptionalflexDirection?: string

OptionaljustifyContent?: string

OptionalpaddingLeft?: number

Settings

On This Page

`Optional`body

`Optional`color?: string

`Optional`flexWrap?: string

`Optional`fontSize?: number

`Optional`paddingBottom?: number

`Optional`width?: string

`Optional`createdAt

`Optional`color?: string

`Optional`fontSize?: number

`Optional`messageContainer

`Optional`flexDirection?: string

`Optional`justifyContent?: string

`Optional`paddingLeft?: number

`Optional`width?: string

`Optional`messageRow

`Optional`backgroundColor?: string

`Optional`borderColor?: string

`Optional`borderStyle?: string

`Optional`borderTopWidth?: number

`Optional`flexDirection?: string

`Optional`height?: number

`Optional`paddingBottom?: number

`Optional`paddingTop?: number

`Optional`navTitle

`Optional`noMessagesBody

`Optional`noMessagesTitle

`Optional`readMessageThumbnailContainer

`Optional`flexDirection?: string

`Optional`justifyContent?: string

`Optional`paddingLeft?: number

`Optional`title

`Optional`fontSize?: number

`Optional`paddingBottom?: number

`Optional`unreadIndicator

`Optional`backgroundColor?: string

`Optional`borderRadius?: number

`Optional`height?: number

`Optional`marginLeft?: number

`Optional`marginRight?: number

`Optional`marginTop?: number

`Optional`width?: number

`Optional`unreadIndicatorContainer

`Optional`flexDirection?: string

`Optional`justifyContent?: string

`Optional`unreadMessageThumbnailContainer

`Optional`flexDirection?: string

`Optional`justifyContent?: string

`Optional`paddingLeft?: number