api
library
Classes
AbstractWebhookPayload
AbstractWebhookPayloadEventNameEnum
AbstractWebhookPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of AbstractWebhookPayloadEventNameEnum to String,
and decode dynamic data back to AbstractWebhookPayloadEventNameEnum .
AliasControllerApi
AliasDto
AliasProjection
ApiClient
ApiKeyAuth
AttachmentControllerApi
AttachmentEntity
AttachmentMetaData
AttachmentProjection
Authentication
BasicAuthOptions
BounceControllerApi
BouncedEmailDto
BouncedRecipientDto
BounceProjection
BounceRecipientProjection
BulkActionsControllerApi
BulkSendEmailOptions
CommonActionsControllerApi
Complaint
ConditionOption
ConditionOptionConditionEnum
Condition of an email object that can be used to filter results
ConditionOptionConditionEnumTypeTransformer
Transformation class that can encode an instance of ConditionOptionConditionEnum to String,
and decode dynamic data back to ConditionOptionConditionEnum .
ConditionOptionValueEnum
Expected condition value
ConditionOptionValueEnumTypeTransformer
Transformation class that can encode an instance of ConditionOptionValueEnum to String,
and decode dynamic data back to ConditionOptionValueEnum .
ConnectorControllerApi
ConnectorDto
ConnectorDtoConnectorAuthTypeEnum
ConnectorDtoConnectorAuthTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectorDtoConnectorAuthTypeEnum to String,
and decode dynamic data back to ConnectorDtoConnectorAuthTypeEnum .
ConnectorDtoConnectorTypeEnum
ConnectorDtoConnectorTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectorDtoConnectorTypeEnum to String,
and decode dynamic data back to ConnectorDtoConnectorTypeEnum .
ConnectorDtoSyncScheduleTypeEnum
ConnectorDtoSyncScheduleTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectorDtoSyncScheduleTypeEnum to String,
and decode dynamic data back to ConnectorDtoSyncScheduleTypeEnum .
ConnectorProjection
ConnectorProjectionConnectorTypeEnum
ConnectorProjectionConnectorTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectorProjectionConnectorTypeEnum to String,
and decode dynamic data back to ConnectorProjectionConnectorTypeEnum .
ConnectorProjectionSyncScheduleTypeEnum
ConnectorProjectionSyncScheduleTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectorProjectionSyncScheduleTypeEnum to String,
and decode dynamic data back to ConnectorProjectionSyncScheduleTypeEnum .
ConnectorSyncEventDto
ConnectorSyncEventDtoSyncStatusEnum
ConnectorSyncEventDtoSyncStatusEnumTypeTransformer
Transformation class that can encode an instance of ConnectorSyncEventDtoSyncStatusEnum to String,
and decode dynamic data back to ConnectorSyncEventDtoSyncStatusEnum .
ConnectorSyncEventProjection
ConnectorSyncEventProjectionSyncStatusEnum
ConnectorSyncEventProjectionSyncStatusEnumTypeTransformer
Transformation class that can encode an instance of ConnectorSyncEventProjectionSyncStatusEnum to String,
and decode dynamic data back to ConnectorSyncEventProjectionSyncStatusEnum .
ConnectorSyncRequestResult
ConnectorSyncRequestResultException
ConnectorSyncRequestResultExceptionCause
ConnectorSyncRequestResultExceptionCauseStackTraceInner
ConnectorSyncRequestResultExceptionCauseSuppressedInner
ConnectorSyncResult
ContactControllerApi
ContactDto
ContactProjection
ContentMatchOptions
CountDto
CreateAliasOptions
CreateConnectorImapOptions
CreateConnectorOptions
CreateConnectorOptionsConnectorAuthTypeEnum
CreateConnectorOptionsConnectorAuthTypeEnumTypeTransformer
Transformation class that can encode an instance of CreateConnectorOptionsConnectorAuthTypeEnum to String,
and decode dynamic data back to CreateConnectorOptionsConnectorAuthTypeEnum .
CreateConnectorOptionsConnectorTypeEnum
CreateConnectorOptionsConnectorTypeEnumTypeTransformer
Transformation class that can encode an instance of CreateConnectorOptionsConnectorTypeEnum to String,
and decode dynamic data back to CreateConnectorOptionsConnectorTypeEnum .
CreateConnectorOptionsSyncScheduleTypeEnum
CreateConnectorOptionsSyncScheduleTypeEnumTypeTransformer
Transformation class that can encode an instance of CreateConnectorOptionsSyncScheduleTypeEnum to String,
and decode dynamic data back to CreateConnectorOptionsSyncScheduleTypeEnum .
CreateContactOptions
CreateDomainOptions
CreateDomainOptionsDomainTypeEnum
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
CreateDomainOptionsDomainTypeEnumTypeTransformer
Transformation class that can encode an instance of CreateDomainOptionsDomainTypeEnum to String,
and decode dynamic data back to CreateDomainOptionsDomainTypeEnum .
CreateEmergencyAddressOptions
CreateEmergencyAddressOptionsIsoCountryCodeEnum
CreateEmergencyAddressOptionsIsoCountryCodeEnumTypeTransformer
Transformation class that can encode an instance of CreateEmergencyAddressOptionsIsoCountryCodeEnum to String,
and decode dynamic data back to CreateEmergencyAddressOptionsIsoCountryCodeEnum .
CreateGroupOptions
CreateInboxDto
CreateInboxDtoInboxTypeEnum
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
CreateInboxDtoInboxTypeEnumTypeTransformer
Transformation class that can encode an instance of CreateInboxDtoInboxTypeEnum to String,
and decode dynamic data back to CreateInboxDtoInboxTypeEnum .
CreateInboxForwarderOptions
CreateInboxForwarderOptionsFieldEnum
Field to match against to trigger inbox forwarding for inbound email
CreateInboxForwarderOptionsFieldEnumTypeTransformer
Transformation class that can encode an instance of CreateInboxForwarderOptionsFieldEnum to String,
and decode dynamic data back to CreateInboxForwarderOptionsFieldEnum .
CreateInboxReplierOptions
CreateInboxReplierOptionsFieldEnum
Field to match against to trigger inbox replier for inbound email
CreateInboxReplierOptionsFieldEnumTypeTransformer
Transformation class that can encode an instance of CreateInboxReplierOptionsFieldEnum to String,
and decode dynamic data back to CreateInboxReplierOptionsFieldEnum .
CreateInboxRulesetOptions
CreateInboxRulesetOptionsActionEnum
Action to be taken when the ruleset matches an email for the given scope. For example: BLOCK action with target * and scope SENDING_EMAILS blocks sending to all recipients. Note ALLOW takes precedent over BLOCK. FILTER_REMOVE is like block but will remove offending email addresses during a send or receive event instead of blocking the action.
CreateInboxRulesetOptionsActionEnumTypeTransformer
Transformation class that can encode an instance of CreateInboxRulesetOptionsActionEnum to String,
and decode dynamic data back to CreateInboxRulesetOptionsActionEnum .
CreateInboxRulesetOptionsScopeEnum
What type of emails actions to apply ruleset to. Either SENDING_EMAILS or RECEIVING_EMAILS will apply action and target to any sending or receiving of emails respectively.
CreateInboxRulesetOptionsScopeEnumTypeTransformer
Transformation class that can encode an instance of CreateInboxRulesetOptionsScopeEnum to String,
and decode dynamic data back to CreateInboxRulesetOptionsScopeEnum .
CreateTemplateOptions
CreateTrackingPixelOptions
CreateWebhookOptions
CreateWebhookOptionsEventNameEnum
Optional webhook event name. Default is EMAIL_RECEIVED and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.
CreateWebhookOptionsEventNameEnumTypeTransformer
Transformation class that can encode an instance of CreateWebhookOptionsEventNameEnum to String,
and decode dynamic data back to CreateWebhookOptionsEventNameEnum .
DeliveryStatusDto
DescribeDomainOptions
DescribeMailServerDomainResult
DeserializationMessage
Primarily intended for use in an isolate.
DNSLookupOptions
DNSLookupOptionsRecordTypesEnum
Domain Name Server Record Types
DNSLookupOptionsRecordTypesEnumTypeTransformer
Transformation class that can encode an instance of DNSLookupOptionsRecordTypesEnum to String,
and decode dynamic data back to DNSLookupOptionsRecordTypesEnum .
DNSLookupResult
DNSLookupResultRecordTypeEnum
Domain Name Server Record Types
DNSLookupResultRecordTypeEnumTypeTransformer
Transformation class that can encode an instance of DNSLookupResultRecordTypeEnum to String,
and decode dynamic data back to DNSLookupResultRecordTypeEnum .
DNSLookupResults
DomainControllerApi
DomainDto
DomainDtoDomainTypeEnum
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
DomainDtoDomainTypeEnumTypeTransformer
Transformation class that can encode an instance of DomainDtoDomainTypeEnum to String,
and decode dynamic data back to DomainDtoDomainTypeEnum .
DomainIssuesDto
DomainNameRecord
DomainNameRecordLabelEnum
Domain Name Server Record Label
DomainNameRecordLabelEnumTypeTransformer
Transformation class that can encode an instance of DomainNameRecordLabelEnum to String,
and decode dynamic data back to DomainNameRecordLabelEnum .
DomainNameRecordRecordTypeEnum
Domain Name Server Record Types
DomainNameRecordRecordTypeEnumTypeTransformer
Transformation class that can encode an instance of DomainNameRecordRecordTypeEnum to String,
and decode dynamic data back to DomainNameRecordRecordTypeEnum .
DomainPreview
DomainPreviewDomainTypeEnum
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
DomainPreviewDomainTypeEnumTypeTransformer
Transformation class that can encode an instance of DomainPreviewDomainTypeEnum to String,
and decode dynamic data back to DomainPreviewDomainTypeEnum .
DownloadAttachmentDto
Email
EmailAnalysis
EmailContentMatchResult
EmailControllerApi
EmailHtmlDto
EmailLinksResult
EmailPreview
EmailPreviewUrls
EmailProjection
EmailRecipients
EmailTextLinesResult
EmailValidationRequestDto
EmailVerificationControllerApi
EmailVerificationResult
EmergencyAddress
EmergencyAddressDto
EmergencyAddressDtoPhoneCountryEnum
EmergencyAddressDtoPhoneCountryEnumTypeTransformer
Transformation class that can encode an instance of EmergencyAddressDtoPhoneCountryEnum to String,
and decode dynamic data back to EmergencyAddressDtoPhoneCountryEnum .
EmergencyAddressPhoneCountryEnum
EmergencyAddressPhoneCountryEnumTypeTransformer
Transformation class that can encode an instance of EmergencyAddressPhoneCountryEnum to String,
and decode dynamic data back to EmergencyAddressPhoneCountryEnum .
EmptyResponseDto
ExpirationDefaults
ExpiredControllerApi
ExpiredInboxDto
ExpiredInboxRecordProjection
ExportControllerApi
ExportLink
ExportOptions
ExportOptionsOutputFormatEnum
ExportOptionsOutputFormatEnumTypeTransformer
Transformation class that can encode an instance of ExportOptionsOutputFormatEnum to String,
and decode dynamic data back to ExportOptionsOutputFormatEnum .
FilterBouncedRecipientsOptions
FilterBouncedRecipientsResult
FlushExpiredInboxesResult
FormControllerApi
ForwardEmailOptions
GenerateBimiRecordOptions
GenerateBimiRecordOptionsVersionEnum
GenerateBimiRecordOptionsVersionEnumTypeTransformer
Transformation class that can encode an instance of GenerateBimiRecordOptionsVersionEnum to String,
and decode dynamic data back to GenerateBimiRecordOptionsVersionEnum .
GenerateBimiRecordResults
GenerateBimiRecordResultsTypeEnum
Domain Name Server Record Types
GenerateBimiRecordResultsTypeEnumTypeTransformer
Transformation class that can encode an instance of GenerateBimiRecordResultsTypeEnum to String,
and decode dynamic data back to GenerateBimiRecordResultsTypeEnum .
GenerateDmarcRecordOptions
Transformation class that can encode an instance of GenerateDmarcRecordOptionsAdkimEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsAdkimEnum .
GenerateDmarcRecordOptionsAspfEnum
GenerateDmarcRecordOptionsAspfEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsAspfEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsAspfEnum .
GenerateDmarcRecordOptionsFoEnum
GenerateDmarcRecordOptionsFoEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsFoEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsFoEnum .
GenerateDmarcRecordOptionsPolicyEnum
GenerateDmarcRecordOptionsPolicyEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsPolicyEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsPolicyEnum .
GenerateDmarcRecordOptionsReportFormatEnum
GenerateDmarcRecordOptionsReportFormatEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsReportFormatEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsReportFormatEnum .
GenerateDmarcRecordOptionsSubdomainPolicyEnum
GenerateDmarcRecordOptionsSubdomainPolicyEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsSubdomainPolicyEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsSubdomainPolicyEnum .
GenerateDmarcRecordOptionsVersionEnum
GenerateDmarcRecordOptionsVersionEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordOptionsVersionEnum to String,
and decode dynamic data back to GenerateDmarcRecordOptionsVersionEnum .
GenerateDmarcRecordResults
GenerateDmarcRecordResultsTypeEnum
Domain Name Server Record Types
GenerateDmarcRecordResultsTypeEnumTypeTransformer
Transformation class that can encode an instance of GenerateDmarcRecordResultsTypeEnum to String,
and decode dynamic data back to GenerateDmarcRecordResultsTypeEnum .
GenerateMtaStsRecordOptions
GenerateMtaStsRecordOptionsModeEnum
GenerateMtaStsRecordOptionsModeEnumTypeTransformer
Transformation class that can encode an instance of GenerateMtaStsRecordOptionsModeEnum to String,
and decode dynamic data back to GenerateMtaStsRecordOptionsModeEnum .
GenerateMtaStsRecordOptionsVersionEnum
GenerateMtaStsRecordOptionsVersionEnumTypeTransformer
Transformation class that can encode an instance of GenerateMtaStsRecordOptionsVersionEnum to String,
and decode dynamic data back to GenerateMtaStsRecordOptionsVersionEnum .
GenerateMtaStsRecordResults
GenerateMtaStsRecordResultsTypeEnum
Domain Name Server Record Types
GenerateMtaStsRecordResultsTypeEnumTypeTransformer
Transformation class that can encode an instance of GenerateMtaStsRecordResultsTypeEnum to String,
and decode dynamic data back to GenerateMtaStsRecordResultsTypeEnum .
GenerateTlsReportingRecordOptions
GenerateTlsReportingRecordOptionsVersionEnum
GenerateTlsReportingRecordOptionsVersionEnumTypeTransformer
Transformation class that can encode an instance of GenerateTlsReportingRecordOptionsVersionEnum to String,
and decode dynamic data back to GenerateTlsReportingRecordOptionsVersionEnum .
GenerateTlsReportingRecordResults
GenerateTlsReportingRecordResultsTypeEnum
Domain Name Server Record Types
GenerateTlsReportingRecordResultsTypeEnumTypeTransformer
Transformation class that can encode an instance of GenerateTlsReportingRecordResultsTypeEnum to String,
and decode dynamic data back to GenerateTlsReportingRecordResultsTypeEnum .
GravatarUrl
GroupContactsDto
GroupControllerApi
GroupDto
GroupProjection
HTMLValidationResult
HttpBasicAuth
HttpBearerAuth
ImapFlagOperationOptions
ImapFlagOperationOptionsFlagOperationEnum
ImapFlagOperationOptionsFlagOperationEnumTypeTransformer
Transformation class that can encode an instance of ImapFlagOperationOptionsFlagOperationEnum to String,
and decode dynamic data back to ImapFlagOperationOptionsFlagOperationEnum .
ImapSmtpAccessDetails
InboxByEmailAddressResult
InboxByNameResult
InboxControllerApi
InboxDto
InboxDtoInboxTypeEnum
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
InboxDtoInboxTypeEnumTypeTransformer
Transformation class that can encode an instance of InboxDtoInboxTypeEnum to String,
and decode dynamic data back to InboxDtoInboxTypeEnum .
InboxExistsDto
InboxForwarderControllerApi
InboxForwarderDto
InboxForwarderDtoFieldEnum
Which field to match against
InboxForwarderDtoFieldEnumTypeTransformer
Transformation class that can encode an instance of InboxForwarderDtoFieldEnum to String,
and decode dynamic data back to InboxForwarderDtoFieldEnum .
InboxForwarderEventProjection
InboxForwarderEventProjectionStatusEnum
InboxForwarderEventProjectionStatusEnumTypeTransformer
Transformation class that can encode an instance of InboxForwarderEventProjectionStatusEnum to String,
and decode dynamic data back to InboxForwarderEventProjectionStatusEnum .
InboxForwarderTestOptions
InboxForwarderTestResult
InboxIdItem
InboxIdsResult
InboxPreview
InboxPreviewInboxTypeEnum
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
InboxPreviewInboxTypeEnumTypeTransformer
Transformation class that can encode an instance of InboxPreviewInboxTypeEnum to String,
and decode dynamic data back to InboxPreviewInboxTypeEnum .
InboxReplierControllerApi
InboxReplierDto
InboxReplierDtoFieldEnum
InboxReplierDtoFieldEnumTypeTransformer
Transformation class that can encode an instance of InboxReplierDtoFieldEnum to String,
and decode dynamic data back to InboxReplierDtoFieldEnum .
InboxReplierEventProjection
InboxReplierEventProjectionStatusEnum
InboxReplierEventProjectionStatusEnumTypeTransformer
Transformation class that can encode an instance of InboxReplierEventProjectionStatusEnum to String,
and decode dynamic data back to InboxReplierEventProjectionStatusEnum .
InboxRulesetControllerApi
InboxRulesetDto
InboxRulesetDtoActionEnum
InboxRulesetDtoActionEnumTypeTransformer
Transformation class that can encode an instance of InboxRulesetDtoActionEnum to String,
and decode dynamic data back to InboxRulesetDtoActionEnum .
InboxRulesetDtoHandlerEnum
InboxRulesetDtoHandlerEnumTypeTransformer
Transformation class that can encode an instance of InboxRulesetDtoHandlerEnum to String,
and decode dynamic data back to InboxRulesetDtoHandlerEnum .
InboxRulesetDtoScopeEnum
InboxRulesetDtoScopeEnumTypeTransformer
Transformation class that can encode an instance of InboxRulesetDtoScopeEnum to String,
and decode dynamic data back to InboxRulesetDtoScopeEnum .
InboxRulesetTestOptions
InboxRulesetTestResult
IPAddressResult
JSONSchemaDto
ListUnsubscribeRecipientProjection
LookupBimiDomainOptions
LookupBimiDomainResults
LookupDmarcDomainOptions
LookupDmarcDomainResults
LookupMtaStsDomainOptions
LookupMtaStsDomainResults
LookupTlsReportingDomainOptions
LookupTlsReportingDomainResults
MailServerControllerApi
MatchOption
MatchOptionFieldEnum
Fields of an email object that can be used to filter results
MatchOptionFieldEnumTypeTransformer
Transformation class that can encode an instance of MatchOptionFieldEnum to String,
and decode dynamic data back to MatchOptionFieldEnum .
MatchOptions
MatchOptionShouldEnum
How the value of the email field specified should be compared to the value given in the match options.
MatchOptionShouldEnumTypeTransformer
Transformation class that can encode an instance of MatchOptionShouldEnum to String,
and decode dynamic data back to MatchOptionShouldEnum .
MissedEmailControllerApi
MissedEmailDto
MissedEmailProjection
NameServerRecord
OAuth
OrganizationInboxProjection
OrganizationInboxProjectionInboxTypeEnum
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
OrganizationInboxProjectionInboxTypeEnumTypeTransformer
Transformation class that can encode an instance of OrganizationInboxProjectionInboxTypeEnum to String,
and decode dynamic data back to OrganizationInboxProjectionInboxTypeEnum .
PageableObject
PageAlias
PageAttachmentEntity
PageBouncedEmail
PageBouncedRecipients
PageComplaint
PageConnector
PageConnectorSyncEvents
PageContactProjection
PageDeliveryStatus
PageEmailPreview
PageEmailProjection
PageEmailValidationRequest
PageExpiredInboxRecordProjection
PageGroupProjection
PageInboxForwarderDto
PageInboxForwarderEvents
PageInboxProjection
PageInboxReplierDto
PageInboxReplierEvents
PageInboxRulesetDto
PageListUnsubscribeRecipients
PageMissedEmailProjection
PageOrganizationInboxProjection
PagePhoneNumberProjection
PageScheduledJobs
PageSentEmailProjection
PageSentEmailWithQueueProjection
PageSmsProjection
PageTemplateProjection
PageThreadProjection
PageTrackingPixelProjection
PageUnknownMissedEmailProjection
PageWebhookProjection
PageWebhookResult
PhoneControllerApi
PhoneNumberDto
PhoneNumberDtoPhoneCountryEnum
PhoneNumberDtoPhoneCountryEnumTypeTransformer
Transformation class that can encode an instance of PhoneNumberDtoPhoneCountryEnum to String,
and decode dynamic data back to PhoneNumberDtoPhoneCountryEnum .
PhoneNumberProjection
PhoneNumberProjectionPhoneCountryEnum
PhoneNumberProjectionPhoneCountryEnumTypeTransformer
Transformation class that can encode an instance of PhoneNumberProjectionPhoneCountryEnum to String,
and decode dynamic data back to PhoneNumberProjectionPhoneCountryEnum .
PhonePlanDto
PhonePlanDtoPhoneCountryEnum
PhonePlanDtoPhoneCountryEnumTypeTransformer
Transformation class that can encode an instance of PhonePlanDtoPhoneCountryEnum to String,
and decode dynamic data back to PhonePlanDtoPhoneCountryEnum .
QueryParam
RawEmailJson
Recipient
ReplyForSms
ReplyToAliasEmailOptions
ReplyToAliasEmailOptionsSendStrategyEnum
How an email should be sent based on its recipients
ReplyToAliasEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of ReplyToAliasEmailOptionsSendStrategyEnum to String,
and decode dynamic data back to ReplyToAliasEmailOptionsSendStrategyEnum .
ReplyToEmailOptions
ReplyToEmailOptionsSendStrategyEnum
How an email should be sent based on its recipients
ReplyToEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of ReplyToEmailOptionsSendStrategyEnum to String,
and decode dynamic data back to ReplyToEmailOptionsSendStrategyEnum .
ScheduledJob
ScheduledJobDto
ScheduledJobDtoStatusEnum
ScheduledJobDtoStatusEnumTypeTransformer
Transformation class that can encode an instance of ScheduledJobDtoStatusEnum to String,
and decode dynamic data back to ScheduledJobDtoStatusEnum .
ScheduledJobStatusEnum
ScheduledJobStatusEnumTypeTransformer
Transformation class that can encode an instance of ScheduledJobStatusEnum to String,
and decode dynamic data back to ScheduledJobStatusEnum .
SendEmailOptions
SendEmailOptionsSendStrategyEnum
How an email should be sent based on its recipients
SendEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of SendEmailOptionsSendStrategyEnum to String,
and decode dynamic data back to SendEmailOptionsSendStrategyEnum .
SendEmailOptionsValidateEmailAddressesEnum
Validate recipient email addresses before sending
SendEmailOptionsValidateEmailAddressesEnumTypeTransformer
Transformation class that can encode an instance of SendEmailOptionsValidateEmailAddressesEnum to String,
and decode dynamic data back to SendEmailOptionsValidateEmailAddressesEnum .
Sender
SendSMTPEnvelopeOptions
SendWithQueueResult
SentEmailDto
SentEmailProjection
SentEmailsControllerApi
SentSmsDto
SetInboxFavouritedOptions
SimpleSendEmailOptions
SmsControllerApi
SmsDto
SmsMatchOption
SmsMatchOptionFieldEnum
Fields of an SMS object that can be used to filter results
SmsMatchOptionFieldEnumTypeTransformer
Transformation class that can encode an instance of SmsMatchOptionFieldEnum to String,
and decode dynamic data back to SmsMatchOptionFieldEnum .
SmsMatchOptionShouldEnum
How the value of the email field specified should be compared to the value given in the match options.
SmsMatchOptionShouldEnumTypeTransformer
Transformation class that can encode an instance of SmsMatchOptionShouldEnum to String,
and decode dynamic data back to SmsMatchOptionShouldEnum .
SmsPreview
SmsProjection
SmsReplyOptions
Sort
TemplateControllerApi
TemplateDto
TemplatePreview
TemplateProjection
TemplateVariable
TemplateVariableVariableTypeEnum
The type of variable
TemplateVariableVariableTypeEnumTypeTransformer
Transformation class that can encode an instance of TemplateVariableVariableTypeEnum to String,
and decode dynamic data back to TemplateVariableVariableTypeEnum .
TestNewInboxForwarderOptions
TestNewInboxRulesetOptions
TestPhoneNumberOptions
ThreadProjection
ToolsControllerApi
TrackingControllerApi
TrackingPixelDto
TrackingPixelProjection
UnknownMissedEmailProjection
UnreadCount
UnseenErrorCountDto
UpdateAliasOptions
UpdateDomainOptions
UpdateGroupContacts
UpdateInboxOptions
UpdateInboxReplierOptions
UpdateInboxReplierOptionsFieldEnum
Field to match against to trigger inbox replier for inbound email
UpdateInboxReplierOptionsFieldEnumTypeTransformer
Transformation class that can encode an instance of UpdateInboxReplierOptionsFieldEnum to String,
and decode dynamic data back to UpdateInboxReplierOptionsFieldEnum .
UploadAttachmentBytesRequest
UploadAttachmentOptions
UploadMultipartFormRequest
UserControllerApi
UserInfoDto
UserInfoDtoAccountStateEnum
UserInfoDtoAccountStateEnumTypeTransformer
Transformation class that can encode an instance of UserInfoDtoAccountStateEnum to String,
and decode dynamic data back to UserInfoDtoAccountStateEnum .
UserInfoDtoAccountTypeEnum
UserInfoDtoAccountTypeEnumTypeTransformer
Transformation class that can encode an instance of UserInfoDtoAccountTypeEnum to String,
and decode dynamic data back to UserInfoDtoAccountTypeEnum .
UserInfoDtoSubscriptionTypeEnum
UserInfoDtoSubscriptionTypeEnumTypeTransformer
Transformation class that can encode an instance of UserInfoDtoSubscriptionTypeEnum to String,
and decode dynamic data back to UserInfoDtoSubscriptionTypeEnum .
ValidateEmailAddressListOptions
ValidateEmailAddressListResult
ValidationDto
ValidationMessage
VerifyEmailAddressOptions
VerifyWebhookSignatureOptions
VerifyWebhookSignatureResults
WaitForConditions
WaitForConditionsCountTypeEnum
How result size should be compared with the expected size. Exactly or at-least matching result?
WaitForConditionsCountTypeEnumTypeTransformer
Transformation class that can encode an instance of WaitForConditionsCountTypeEnum to String,
and decode dynamic data back to WaitForConditionsCountTypeEnum .
WaitForConditionsSortDirectionEnum
Direction to sort matching emails by created time
WaitForConditionsSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of WaitForConditionsSortDirectionEnum to String,
and decode dynamic data back to WaitForConditionsSortDirectionEnum .
WaitForControllerApi
WaitForSingleSmsOptions
WaitForSingleSmsOptionsSortDirectionEnum
WaitForSingleSmsOptionsSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of WaitForSingleSmsOptionsSortDirectionEnum to String,
and decode dynamic data back to WaitForSingleSmsOptionsSortDirectionEnum .
WaitForSmsConditions
WaitForSmsConditionsCountTypeEnum
How result size should be compared with the expected size. Exactly or at-least matching result?
WaitForSmsConditionsCountTypeEnumTypeTransformer
Transformation class that can encode an instance of WaitForSmsConditionsCountTypeEnum to String,
and decode dynamic data back to WaitForSmsConditionsCountTypeEnum .
WaitForSmsConditionsSortDirectionEnum
Direction to sort matching SMSs by created time
WaitForSmsConditionsSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of WaitForSmsConditionsSortDirectionEnum to String,
and decode dynamic data back to WaitForSmsConditionsSortDirectionEnum .
WebhookBouncePayload
WebhookBouncePayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookBouncePayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookBouncePayloadEventNameEnum to String,
and decode dynamic data back to WebhookBouncePayloadEventNameEnum .
WebhookBounceRecipientPayload
WebhookBounceRecipientPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookBounceRecipientPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookBounceRecipientPayloadEventNameEnum to String,
and decode dynamic data back to WebhookBounceRecipientPayloadEventNameEnum .
WebhookControllerApi
WebhookDeliveryStatusPayload
WebhookDeliveryStatusPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookDeliveryStatusPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookDeliveryStatusPayloadEventNameEnum to String,
and decode dynamic data back to WebhookDeliveryStatusPayloadEventNameEnum .
WebhookDto
WebhookDtoEventNameEnum
Webhook trigger event name
WebhookDtoEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookDtoEventNameEnum to String,
and decode dynamic data back to WebhookDtoEventNameEnum .
WebhookDtoMethodEnum
HTTP method that your server endpoint must listen for
WebhookDtoMethodEnumTypeTransformer
Transformation class that can encode an instance of WebhookDtoMethodEnum to String,
and decode dynamic data back to WebhookDtoMethodEnum .
WebhookEmailOpenedPayload
WebhookEmailOpenedPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookEmailOpenedPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookEmailOpenedPayloadEventNameEnum to String,
and decode dynamic data back to WebhookEmailOpenedPayloadEventNameEnum .
WebhookEmailReadPayload
WebhookEmailReadPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookEmailReadPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookEmailReadPayloadEventNameEnum to String,
and decode dynamic data back to WebhookEmailReadPayloadEventNameEnum .
WebhookNewAttachmentPayload
WebhookNewAttachmentPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewAttachmentPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookNewAttachmentPayloadEventNameEnum to String,
and decode dynamic data back to WebhookNewAttachmentPayloadEventNameEnum .
WebhookNewContactPayload
WebhookNewContactPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewContactPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookNewContactPayloadEventNameEnum to String,
and decode dynamic data back to WebhookNewContactPayloadEventNameEnum .
WebhookNewEmailPayload
WebhookNewEmailPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewEmailPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookNewEmailPayloadEventNameEnum to String,
and decode dynamic data back to WebhookNewEmailPayloadEventNameEnum .
WebhookNewSmsPayload
WebhookNewSmsPayloadEventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewSmsPayloadEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookNewSmsPayloadEventNameEnum to String,
and decode dynamic data back to WebhookNewSmsPayloadEventNameEnum .
WebhookProjection
WebhookProjectionEventNameEnum
WebhookProjectionEventNameEnumTypeTransformer
Transformation class that can encode an instance of WebhookProjectionEventNameEnum to String,
and decode dynamic data back to WebhookProjectionEventNameEnum .
WebhookRedriveResult
WebhookResultDto
WebhookResultDtoHttpMethodEnum
WebhookResultDtoHttpMethodEnumTypeTransformer
Transformation class that can encode an instance of WebhookResultDtoHttpMethodEnum to String,
and decode dynamic data back to WebhookResultDtoHttpMethodEnum .
WebhookResultDtoResultTypeEnum
WebhookResultDtoResultTypeEnumTypeTransformer
Transformation class that can encode an instance of WebhookResultDtoResultTypeEnum to String,
and decode dynamic data back to WebhookResultDtoResultTypeEnum .
WebhookResultDtoWebhookEventEnum
WebhookResultDtoWebhookEventEnumTypeTransformer
Transformation class that can encode an instance of WebhookResultDtoWebhookEventEnum to String,
and decode dynamic data back to WebhookResultDtoWebhookEventEnum .
WebhookTestRequest
WebhookTestRequestMethodEnum
WebhookTestRequestMethodEnumTypeTransformer
Transformation class that can encode an instance of WebhookTestRequestMethodEnum to String,
and decode dynamic data back to WebhookTestRequestMethodEnum .
WebhookTestResponse
WebhookTestResult
Functions
deserializeAsync (DeserializationMessage message → Future
Primarily intended for use in an isolate.
mapCastOfType <K , V > (dynamic map , String key → Map <K , V > ?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime (dynamic map , String key , [String ?pattern → DateTime ?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType <T > (dynamic map , String key → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString (dynamic value → String
Format the given parameter object into a String .
serializeAsync (Object ?value → Future <String
Primarily intended for use in an isolate.
