lib/com.prettybyte.plugins

Package-level declarations

Types

CreateEmailParams

data class CreateEmailParams(val email: PluginPostmarkEmailString)

EmailPluginPage

class EmailPluginPage<C : KlerkContext, V>(emailCollections: ModelCollections<PluginPostmarkEmail, C>, webhooksAuth: PostmarkEmailWebhooksAuth) : PluginPage<C, V>

object LinkClicked : InstanceEventWithParameters<PluginMagicLinkAuthenticationCode, LinkClickedParams>

LinkClickedParams

data class LinkClickedParams(val user: PluginMagicLinkAuthenticationUserRef, val code: PluginMagicLinkAuthenticationCodeContainer)

sealed class LoginResult

LogPluginPostmarkEmailFailed

class LogPluginPostmarkEmailFailed(willRetry: Boolean, context: KlerkContext?, status: HttpStatusCode, message: String) : LogEntry

LogPluginPostmarkEmailSucceeded

class LogPluginPostmarkEmailSucceeded(context: KlerkContext?) : LogEntry

MagicLinkAuthentication

class MagicLinkAuthentication<C : KlerkContext, V>(url: String) : KlerkPlugin<C, V>

Plugin for authenticating by sending an email with a login link.

PluginMagicLinkAuthenticationCode

data class PluginMagicLinkAuthenticationCode(val user: PluginMagicLinkAuthenticationUserRef, val email: PluginMagicLinkAuthenticationEmailAddress, val code: PluginMagicLinkAuthenticationCodeContainer)

PluginMagicLinkAuthenticationCodeContainer

class PluginMagicLinkAuthenticationCodeContainer(value: Long) : LongContainer

PluginMagicLinkAuthenticationEmailAddress

class PluginMagicLinkAuthenticationEmailAddress(value: String) : StringContainer

PluginMagicLinkAuthenticationUserRef

class PluginMagicLinkAuthenticationUserRef(value: Int) : IntContainer

PluginPostmarkEmail

data class PluginPostmarkEmail(val messageID: PluginPostmarkEmailMessageID?, val jobID: JobIdContainer?, val email: PluginPostmarkEmailString, val status: PluginPostmarkEmailStatus?)

PluginPostmarkEmailJob

class PluginPostmarkEmailJob<C : KlerkContext, V>(emailID: ModelID<PluginPostmarkEmail>) : Job<C, V>

PluginPostmarkEmailMessageID

class PluginPostmarkEmailMessageID(value: String) : StringContainer

PluginPostmarkEmailStatus

class PluginPostmarkEmailStatus(value: String) : StringContainer

PluginPostmarkEmailString

class PluginPostmarkEmailString(value: String) : StringContainer

data class PostmarkEmail(val From: String, val To: String, val Cc: String? = null, val Bcc: String? = null, val Subject: String, val HtmlBody: String?, val TextBody: String?, val MessageStream: String? = null)

PostmarkEmailService

class PostmarkEmailService<C : KlerkContext, V>(apiKey: String, webhooksAuth: PostmarkEmailWebhooksAuth, serverID: Int? = null, val defaultFromAddress: BasicEmail.EmailAndName, messageStream: String = "outbound") : AdminUIPluginIntegration<C, V> , EmailSender<C, V>

Plugin for sending transactional email via Postmark.

PostmarkEmailWebhooksAuth

data class PostmarkEmailWebhooksAuth(val username: String, val password: String)

SendEmailParams

data class SendEmailParams(val messageID: PluginPostmarkEmailMessageID)

StartMagicLinkAuthentication

object StartMagicLinkAuthentication : VoidEventWithParameters<PluginMagicLinkAuthenticationCode, StartMagicLinkAuthenticationParams>

StartMagicLinkAuthenticationParams

data class StartMagicLinkAuthenticationParams(val email: PluginMagicLinkAuthenticationEmailAddress, val user: PluginMagicLinkAuthenticationUserRef)

Functions

fun <C : KlerkContext, V> newEmail(args: ArgForVoidEvent<PluginPostmarkEmail, CreateEmailParams, C, V>): PluginPostmarkEmail

fun <T : Any, P, ModelStates : Enum<*>, C : KlerkContext, V> Block.InstanceEventBlock<T, P, ModelStates, C, V>.sendEmail(function: (ArgForInstanceEvent<T, P, C, V>) -> PostmarkEmail)

fun <T : Any, ModelStates : Enum<*>, C : KlerkContext, V> Block.InstanceNonEventBlock<T, ModelStates, C, V>.sendEmail(function: (ArgForInstanceNonEvent<T, C, V>) -> PostmarkEmail)

fun <T : Any, P, ModelStates : Enum<*>, C : KlerkContext, V> Block.VoidEventBlock<T, P, ModelStates, C, V>.sendEmail(function: (ArgForVoidEvent<T, P, C, V>) -> PostmarkEmail)

Sends an email using PostmarkEmailService

toStringWithoutDots

fun BasicEmail.EmailAndName.toStringWithoutDots(): String

Postmark requires special handling of dots. If the name contains dots, this will only return the email.