sudoemail/com.sudoplatform.sudoemail

Package-level declarations

The main entry point of the Sudo Platform Email SDK for Android. Use the SudoEmailClient.builder() to construct an instance of the Sudo Platform Email SDK.

Types

SudoEmailClient

interface SudoEmailClient : AutoCloseable

Interface encapsulating a library for interacting with the Sudo Platform Email service.

SudoEmailNotifiableClient

interface SudoEmailNotifiableClient : NotifiableClient

Interface encapsulating the NotifiableClient used to handle remove message notifications from the Sudo Platform Email Service.

SudoEmailNotificationHandler

interface SudoEmailNotificationHandler

SudoEmailNotificationMetaData

data class SudoEmailNotificationMetaData(val serviceName: String, val schema: List<SudoEmailNotificationSchemaEntry>) : NotificationMetaData

SudoEmailNotificationSchemaEntry

data class SudoEmailNotificationSchemaEntry(val description: String, val fieldName: String, val type: String) : NotificationSchemaEntry

Functions

initEmailNotifications

fun NotificationConfiguration.initEmailNotifications(): NotificationConfiguration

Extension function to ensure a NotificationConfiguration is initialized for receipt of email service notifications.

isEmailNotificationForAddressIdEnabled

fun NotificationConfiguration.isEmailNotificationForAddressIdEnabled(emailAddressId: String): Boolean

Test whether or not email service notifications are enabled for a particular email address

isEmailNotificationForSudoIdEnabled

fun NotificationConfiguration.isEmailNotificationForSudoIdEnabled(sudoId: String): Boolean

Test whether or not email service notifications are enabled for a particular Sudo

setEmailNotificationsForAddressId

fun NotificationConfiguration.setEmailNotificationsForAddressId(emailAddressId: String, enabled: Boolean): NotificationConfiguration

Extension function to add rules to a NotificationConfiguration for enabling or disabling email service notifications for a particular email address ID.

setEmailNotificationsForSudoId

fun NotificationConfiguration.setEmailNotificationsForSudoId(sudoId: String, enabled: Boolean): NotificationConfiguration

Extension function to add rules to a NotificationConfiguration for enabling or disabling email service notifications for a particular sudo ID.

subscribeToEmailMessages

suspend fun SudoEmailClient.subscribeToEmailMessages(id: String, onConnectionChange: (status: Subscriber.ConnectionState) -> Unit = {}, onEmailMessageChanged: (emailMessage: EmailMessage, type: EmailMessageSubscriber.ChangeType) -> Unit)

Subscribes to be notified of new and deleted EmailMessages.