Type Alias MailAccountApiListMailAccountsRequest

MailAccountApiListMailAccountsRequest: {
    domain?: string;
    hostingId: string;
    orderBy?: ListMailAccountsRequestOrderBy;
    page?: number;
    pageSize?: number;
    region?: Region;
}

Type declaration

  • Optionaldomain?: string

    Domain to filter the mail accounts.

  • hostingId: string

    UUID of the hosting plan.

  • OptionalorderBy?: ListMailAccountsRequestOrderBy

    Sort order of mail accounts in the response.

  • Optionalpage?: number

    Page number (must be a positive integer).

  • OptionalpageSize?: number

    Number of mail accounts to return (must be a positive integer lower or equal to 100).

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

Settings