Note: There is a newer version (1.5.1) of this package available. Click here to view docs for the latest version.
Module mailscript
ballerinax/mailscript Ballerina library
1.5.0
Overview
This is a generated connector from Mailscript API v2 OpenAPI Specification.
Mailscript provides the capability to manage emails.
Clients
mailscript: Client
Isolated
This is a generated connector for Mailscript OpenAPI specification. Mailscript API provides the capability to manage emails.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a Mailscript account and obtain tokens.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.mailscript.com/v2" - URL of the target service
getAllActions
Isolated FunctionRemote Function
function getAllActions() returns GetAllActionsResponse|errorGet all actions for the user
Return Type
- GetAllActionsResponse|error - Successful operation
addAction
Isolated FunctionRemote Function
function addAction(ActionsBody payload) returns AddActionResponse|errorAdd an action
Parameters
- payload ActionsBody - Add action body
Return Type
- AddActionResponse|error - Successful operation
updateAction
Isolated FunctionRemote Function
function updateAction(string action, ActionsActionBody payload) returns Key|errorUpdate an action key
deleteAction
Isolated FunctionRemote Function
Delete an action
Parameters
- action string - ID of the action
getAllAddresses
Isolated FunctionRemote Function
function getAllAddresses() returns GetAllAddressesResponse|errorGet all addresses you have access to
Return Type
- GetAllAddressesResponse|error - successful operation
addAddress
Isolated FunctionRemote Function
function addAddress(AddAddressRequest payload) returns Response|errorClaim a new Mailscript address
Parameters
- payload AddAddressRequest - Address body
deleteAddress
Isolated FunctionRemote Function
Delete a mailscript address
Parameters
- address string - ID of address
getAllKeys
Isolated FunctionRemote Function
function getAllKeys(string address) returns GetAllKeysResponse|errorList address keys
Parameters
- address string - ID of address
Return Type
- GetAllKeysResponse|error - successful operation
addKey
Isolated FunctionRemote Function
function addKey(string address, AddKeyRequest payload) returns AddKeyResponse|errorAdd address key
Return Type
- AddKeyResponse|error - successful operation
getKey
Isolated FunctionRemote Function
Get address key
updateKey
Isolated FunctionRemote Function
function updateKey(string address, string 'key, UpdateKeyRequest payload) returns Key|errorUpdate an address key
deleteKey
Isolated FunctionRemote Function
Delete address key
getDaemonToken
Isolated FunctionRemote Function
function getDaemonToken(string daemon) returns InlineResponse200|errorGet a token for opening a daemon connection
Parameters
- daemon string - name of Daemon
Return Type
- InlineResponse200|error - Successful get operation
getAllDomains
Isolated FunctionRemote Function
function getAllDomains() returns GetAllDomainsResponse|errorGet all domains you have access to
Return Type
- GetAllDomainsResponse|error - successful operation
addDomain
Isolated FunctionRemote Function
function addDomain(AddDomainRequest payload) returns DomainResponse|errorClaim a new Domain
Parameters
- payload AddDomainRequest - Domain body
Return Type
- DomainResponse|error - successful operation
getDomainVerify
Isolated FunctionRemote Function
function getDomainVerify(string domain) returns DomainResponse|errorGet domain verification
Parameters
- domain string - Full Top-level domain name
Return Type
- DomainResponse|error - successful operation
checkDomainVerify
Isolated FunctionRemote Function
function checkDomainVerify(string domain) returns CheckDomainVerify|errorCheck a new Domain
Parameters
- domain string - Full Top-level domain name
Return Type
- CheckDomainVerify|error - successful operation
removeDomainVerify
Isolated FunctionRemote Function
Remove a domain
Parameters
- domain string - Full Top-level domain name
getAllInputs
Isolated FunctionRemote Function
function getAllInputs(string? name) returns GetAllInputsResponse|errorGet all inputs you have access to
Parameters
- name string? (default ()) - Name
Return Type
- GetAllInputsResponse|error - successful operation
getAllIntegrations
Isolated FunctionRemote Function
function getAllIntegrations() returns GetAllIntegrationsResponse|errorGet all integrations for the user
Return Type
- GetAllIntegrationsResponse|error - Successful operation
deleteIntegration
Isolated FunctionRemote Function
Delete an integration
Parameters
- integration string - ID of the integration
send
Isolated FunctionRemote Function
function send(SendRequest payload) returns Response|errorSend an email
Parameters
- payload SendRequest - request body
getAllTriggers
Isolated FunctionRemote Function
function getAllTriggers() returns GetAllTriggersResponse|errorGet all triggers you have access to
Return Type
- GetAllTriggersResponse|error - successful operation
addTrigger
Isolated FunctionRemote Function
function addTrigger(AddTriggerRequest payload) returns AddTriggerResponse|errorSetup a trigger
Parameters
- payload AddTriggerRequest - Trigger body
Return Type
- AddTriggerResponse|error - successful add operation
updateTrigger
Isolated FunctionRemote Function
function updateTrigger(string trigger, AddTriggerRequest payload) returns Response|errorUpdate a trigger
deleteTrigger
Isolated FunctionRemote Function
Delete a trigger
Parameters
- trigger string - ID of the trigger
getAuthenticatedUser
Isolated FunctionRemote Function
Get the authenticated user
updateUser
Isolated FunctionRemote Function
function updateUser(UpdateUserRequest payload) returns Response|errorUpdate a user
Parameters
- payload UpdateUserRequest - User body
getAllVerifications
Isolated FunctionRemote Function
function getAllVerifications() returns GetAllVerificationsResponse|errorGet all verificats for the user
Return Type
- GetAllVerificationsResponse|error - Successful operation
addVerification
Isolated FunctionRemote Function
function addVerification(VerificationsBody payload) returns AddVerificationResponse|errorStart verification process for external email address or sms number
Parameters
- payload VerificationsBody - Key body
Return Type
- AddVerificationResponse|error - Successful operation
verify
Isolated FunctionRemote Function
function verify(string verification, VerificationVerifyBody payload) returns Response|errorVerify an email address or sms number with a code
Parameters
- verification string - ID of the verification entry
- payload VerificationVerifyBody - Verify action body
getAllWorkflows
Isolated FunctionRemote Function
function getAllWorkflows() returns GetAllWorkflowsResponse|errorGet all workflows you have access to
Return Type
- GetAllWorkflowsResponse|error - successful operation
addWorkflow
Isolated FunctionRemote Function
function addWorkflow(AddWorkflowRequest payload) returns Response|errorSetup workflow
Parameters
- payload AddWorkflowRequest - Workflow body
setWorkflow
Isolated FunctionRemote Function
function setWorkflow(SetWorkflowRequest payload) returns Response|errorSet a property on a workflow
Parameters
- payload SetWorkflowRequest - Set Workflow body
updateWorkflow
Isolated FunctionRemote Function
function updateWorkflow(string workflow, AddWorkflowRequest payload) returns Response|errorUpdate an workflow
deleteWorkflow
Isolated FunctionRemote Function
Delete a workflow
Parameters
- workflow string - ID of the workflow
getAllWorkspaces
Isolated FunctionRemote Function
function getAllWorkspaces() returns GetAllWorkspacesResponse|errorGet all workspaces you have access to
Return Type
- GetAllWorkspacesResponse|error - successful operation
addWorkspace
Isolated FunctionRemote Function
function addWorkspace(AddWorkspaceRequest payload) returns Response|errorClaim a Mailscript workspace
Parameters
- payload AddWorkspaceRequest - request body
Records
mailscript: ActionCombine
Fields
- createdAt string -
- createdBy string -
- id string -
- list string[]? -
- name string -
- owner string -
mailscript: ActionSend
Fields
- config ActionsendConfig -
- createdAt string -
- createdBy string -
- id string -
- name string -
- output string -
- owner string -
mailscript: ActionsendConfig
Fields
- html string? -
- subject string -
- text string? -
- 'type string -
mailscript: AddActionAliasRequest
Fields
- config AddactionaliasrequestConfig -
- name string -
- 'type string -
mailscript: AddactionaliasrequestConfig
Fields
- alias string? -
- 'type string? -
mailscript: AddActionCombineRequest
Fields
- list string[] -
- name string -
mailscript: AddActionDaemonRequest
Fields
- config AddactiondaemonrequestConfig -
- name string -
- 'type string -
mailscript: AddactiondaemonrequestConfig
Fields
- body string -
- daemon string? -
mailscript: AddActionForwardRequest
Fields
- config AddactionforwardrequestConfig -
- name string -
- 'type string -
mailscript: AddactionforwardrequestConfig
Fields
- forward string -
- 'from string -
- 'key string -
- 'type string -
mailscript: AddActionReplyAllRequest
Fields
- config AddactionreplyallrequestConfig -
- name string -
- 'type string -
mailscript: AddactionreplyallrequestConfig
Fields
- 'from string -
- html string? -
- 'key string -
- text string? -
- 'type string -
mailscript: AddActionReplyRequest
Fields
- config AddactionreplyrequestConfig -
- name string -
- 'type string -
mailscript: AddactionreplyrequestConfig
Fields
- 'from string -
- html string? -
- 'key string -
- text string? -
- 'type string -
mailscript: AddActionResponse
Fields
- id string -
mailscript: AddActionSendRequest
Fields
- config AddactionsendrequestConfig -
- name string -
- 'type string -
mailscript: AddactionsendrequestConfig
Fields
- 'from string -
- html string? -
- 'key string -
- subject string -
- text string? -
- to string? -
- 'type string? -
mailscript: AddActionSmsRequest
Fields
- config AddactionsmsrequestConfig -
- name string -
- 'type string -
mailscript: AddactionsmsrequestConfig
Fields
- number string -
- text string -
mailscript: AddActionWebhookRequest
Fields
- config AddactionwebhookrequestConfig -
- name string -
- 'type string -
mailscript: AddactionwebhookrequestConfig
Fields
- body string -
- url string -
mailscript: AddactionwebhookrequestConfigOpts
Fields
- headers record {} -
- method string -
mailscript: AddAddressRequest
Fields
- address string -
mailscript: AddDomainRequest
Fields
- domain string -
mailscript: AddEmailVerificationRequest
Fields
- email string -
- 'type string -
mailscript: AddKeyRequest
Fields
- name string -
- read boolean -
- write boolean -
mailscript: AddKeyResponse
Fields
- id string? -
mailscript: Address
Fields
- createdAt string -
- createdBy string -
- displayName string? -
- id string -
- owner string -
mailscript: AddSmsVerificationRequest
Fields
- sms string -
- 'type string -
mailscript: AddTriggerRequest
Fields
- criteria Criteria|CriteriaOperand -
- name string -
mailscript: AddTriggerResponse
Fields
- id string -
mailscript: AddVerificationResponse
Fields
- id string -
mailscript: AddWorkflowRequest
Fields
- action string -
- active boolean? -
- input string -
- name string -
- trigger string? -
mailscript: AddWorkspaceRequest
Fields
- workspace string -
mailscript: CheckDomainVerify
Fields
- domain string -
- success boolean -
mailscript: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
mailscript: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
mailscript: Criteria
Fields
- domain string? -
- 'from string? -
- hasAttachments boolean? -
- hasTheWords string? -
- sentTo string? -
- subjectContains string? -
mailscript: CriteriaOperand
Fields
- and string[]? -
- or string[]? -
mailscript: DomainResponse
Fields
- domain string -
- records DomainresponseRecords[] -
mailscript: DomainresponseRecords
Fields
- name string -
- 'type string -
- value string -
mailscript: ErrorResponse
Fields
- 'error string -
mailscript: GetAllActionsResponse
Fields
- list (ActionSend|ActionCombine)[] -
mailscript: GetAllAddressesResponse
Fields
- list (Address)[] -
mailscript: GetAllDomainsResponse
Fields
- id string[]? -
mailscript: GetAllInputsResponse
Fields
- list (MailscriptEmailInput)[] -
mailscript: GetAllIntegrationsResponse
Fields
- list (Integration)[] -
mailscript: GetAllKeysResponse
Fields
- list (Key)[] -
mailscript: GetAllTriggersResponse
Fields
- list (Trigger)[] -
mailscript: GetAllVerificationsResponse
Fields
- list (VerificationEmail|VerificationSms)[] -
mailscript: GetAllWorkflowsResponse
Fields
- list (Workflow)[] -
mailscript: GetAllWorkspacesResponse
Fields
- list (Workspace)[] -
mailscript: InlineResponse200
Fields
- token string -
mailscript: Integration
Fields
- createdAt string -
- id string -
- 'type string -
mailscript: Key
Fields
- createdAt string -
- createdBy string -
- id string -
- name string -
- read boolean -
- write boolean -
mailscript: KeyValuePair
Fields
- 'key string -
- value string -
mailscript: MailscriptEmailInput
Fields
- address string -
- createdAt string -
- createdBy string -
- id string -
- name string -
- owner string -
- 'type string -
mailscript: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
mailscript: SendRequest
Fields
- 'from string -
- html string? -
- subject string -
- text string? -
- to string -
mailscript: SetWorkflowRequest
Fields
- id string? -
- pairs (KeyValuePair)[]? -
mailscript: Trigger
Fields
- createdAt string -
- createdBy string -
- criteria Criteria -
- displayName string? -
- id string -
- name string -
- owner string -
mailscript: UpdateKeyRequest
Fields
- name string -
- read boolean -
- write boolean -
mailscript: UpdateUserRequest
Fields
- displayName string -
mailscript: User
Fields
- createdAt string -
- displayName string -
- email string -
- id string -
- photoURL string? -
mailscript: VerificationEmail
Fields
- email string? -
- id string? -
- 'type string? -
- verified boolean? -
- verifiedAt string? -
- verifiedBy string? -
mailscript: VerificationSms
Fields
- id string? -
- sms string? -
- 'type string? -
- verified boolean? -
- verifiedAt string? -
- verifiedBy string? -
mailscript: VerifyEmailRequest
Fields
- code string -
- email string -
mailscript: VerifySmsRequest
Fields
- code string -
- sms string -
mailscript: Workflow
Fields
- action string -
- active boolean? -
- createdAt string -
- createdBy string -
- id string -
- input string -
- name string -
- owner string -
- trigger string -
mailscript: Workspace
Fields
- createdAt string -
- createdBy string -
- id string -
- owner string -
Union types
mailscript: ActionsActionBody
ActionsActionBody
mailscript: ActionsBody
ActionsBody
mailscript: VerificationsBody
VerificationsBody
mailscript: VerificationVerifyBody
VerificationVerifyBody