blinkreceipt-digital/com.microblink.digital/ImapClient

ImapClient

class ImapClient : Client

Constructors

ImapClient

constructor(@NonNull context: Context, @NonNull callback: InitializeCallback)

constructor(@NonNull context: Context, threads: Int, @NonNull callback: InitializeCallback)

Functions

accounts

@NonNull

open fun accounts(): Task<List<Credentials.Password>>

@NonNull

open fun accounts(@NonNull executor: Executor): Task<List<Credentials.Password>>

clearLastCheckedTime

@NonNull

open fun clearLastCheckedTime(): Task<Boolean>

@NonNull

open fun clearLastCheckedTime(@NonNull provider: Provider): Task<Boolean>

@NonNull

open fun clearLastCheckedTime(@NonNull executor: Executor, @NonNull providers: Array<Provider>): Task<Boolean>

open fun close()

countryCode

@NonNull

open fun countryCode(): String

open fun countryCode(@NonNull countryCode: String)

dateCutoff

@Nullable

open fun dateCutoff(): Date

@NonNull

open fun dateCutoff(@Nullable dateCutoff: Date): Client

dayCutoff

open fun dayCutoff(): Int

open fun dayCutoff(dayCutoff: Int)

filterSensitive

open fun filterSensitive(): Boolean

open fun filterSensitive(filterSensitive: Boolean)

link

@NonNull

open fun link(@NonNull credentials: Credentials.Password): Task<ProviderSetupResults>

@NonNull

open fun link(@NonNull executor: Executor, @NonNull credentials: Credentials.Password): Task<ProviderSetupResults>

logout

@NonNull

open fun logout(): Task<Boolean>

@NonNull

open fun logout(@NonNull credentials: Credentials.Password): Task<Boolean>

@NonNull

open fun logout(@NonNull executor: Executor, @Nullable credentials: Credentials.Password): Task<Boolean>

messages

@NonNull

open fun messages(@NonNull provider: Provider, @NonNull sender: String, @NonNull html: String): Task<List<ScanResults>>

@NonNull

open fun messages(@NonNull executor: Executor, @NonNull provider: Provider, @NonNull sender: String, @NonNull html: String): Task<List<ScanResults>>

For debugging the parsing of e-receipt HTML

@NonNull

open fun messages(@NonNull credentials: Credentials.Password): Task<List<ScanResults>>

open fun messages(@NonNull callback: MessagesCallback)

@NonNull

open fun messages(@NonNull executor: Executor, @NonNull credentials: Credentials.Password): Task<List<ScanResults>>

open fun messages(@NonNull executor: Executor, @NonNull callback: MessagesCallback)

overrideDate

@Nullable

open fun overrideDate(): Date

@NonNull

open fun overrideDate(@Nullable date: Date): Client

overrideDateTime

@Nullable

open fun overrideDateTime(): Long

@NonNull

open fun overrideDateTime(@Nullable milliseconds: Long): Client

overrideEndpoint

@Nullable

open fun overrideEndpoint(): String

@NonNull

open fun overrideEndpoint(@Nullable endpoint: String): Client

rawEmails

@NonNull

open fun rawEmails(rawEmails: Boolean): ImapClient

remoteMessages

@NonNull

open fun remoteMessages(@NonNull credentials: Credentials.Password): Task<JobResults>

open fun remoteMessages(@NonNull callback: JobResultsCallback)

@NonNull

open fun remoteMessages(@NonNull executor: Executor, @NonNull credentials: Credentials.Password): Task<JobResults>

open fun remoteMessages(@NonNull executor: Executor, @NonNull callback: JobResultsCallback)

@NonNull

open fun remoteMessages(@NonNull email: String, @NonNull provider: Provider, @NonNull eml: String): Task<JobResults>

@NonNull

open fun remoteMessages(@NonNull executor: Executor, @NonNull email: String, @NonNull provider: Provider, @NonNull eml: String): Task<JobResults>

searchUntil

@Nullable

open fun searchUntil(): Date

@NonNull

open fun searchUntil(@Nullable searchUntil: Date): Client

sendersToSearch

@Nullable

open fun sendersToSearch(): Map<String, Merchant>

open fun sendersToSearch(@NonNull senders: Map<String, Merchant>)

If populated, only senders in this list will be searched for e-receipts.

subProducts

open fun subProducts(): Boolean

open fun subProducts(subProducts: Boolean)

useAggregation

open fun useAggregation(): Boolean

open fun useAggregation(useAggregation: Boolean)

verify

@NonNull

open fun verify(@NonNull credentials: Credentials.Password): Task<Boolean>

@NonNull

open fun verify(@NonNull executor: Executor, @NonNull credentials: Credentials.Password): Task<Boolean>