Skip to main content

Provider

Enum of supported email providers.

Package: com.microblink.digital

Declaration

enum class Provider

Quick Reference

Properties & Methods

MemberDescription
IMAPThe set of IMAP-compatible providers
checkIfImapProvider(provider, shouldThrow)Returns true if the provider uses IMAP
imapHosts(provider)Returns the IMAP host configuration for the given provider
imapId(provider)Returns the IMAP identifier string for the given provider
type()Returns a string identifier for this provider

Entries

EntryDescription
GMAILGmail via OAuth (use GmailClient)
OUTLOOK_SDKOutlook via OAuth (use OutlookClient)
AOLAOL Mail via IMAP (use ImapClient)
YAHOOYahoo Mail via IMAP (use ImapClient)

Properties & Methods

IMAP

val IMAP: Set<Provider>

The set of IMAP-compatible providers: {AOL, YAHOO}.


checkIfImapProvider(provider, shouldThrow)

fun checkIfImapProvider(provider: Provider, shouldThrow: Boolean): Boolean

Returns true if the provider uses IMAP. If shouldThrow is true and the provider is not IMAP, throws an exception.


imapHosts(provider)

fun imapHosts(provider: Provider): Host

Returns the IMAP host configuration for the given provider.


imapId(provider)

fun imapId(provider: Provider): String

Returns the IMAP identifier string for the given provider.


type()

fun type(): String

Returns a string identifier for this provider.