mailscript
Module mailscript
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_mailscript_1.5.0.png)
ballerinax/mailscript Ballerina library
Overview
This is a generated connector from Mailscript API v2 OpenAPI Specification.
Mailscript provides the capability to manage emails.
Clients![](/images/permalink.svg)
mailscript: Client![](/images/permalink.svg)
This is a generated connector for Mailscript OpenAPI specification. Mailscript API provides the capability to manage emails.
Constructor![](/images/permalink.svg)
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![](/images/permalink.svg)
function getAllActions() returns GetAllActionsResponse|error
Get all actions for the user
Return Type
- GetAllActionsResponse|error - Successful operation
addAction![](/images/permalink.svg)
function addAction(ActionsBody payload) returns AddActionResponse|error
Add an action
Parameters
- payload ActionsBody - Add action body
Return Type
- AddActionResponse|error - Successful operation
updateAction![](/images/permalink.svg)
function updateAction(string action, ActionsActionBody payload) returns Key|error
Update an action key
deleteAction![](/images/permalink.svg)
Delete an action
Parameters
- action string - ID of the action
getAllAddresses![](/images/permalink.svg)
function getAllAddresses() returns GetAllAddressesResponse|error
Get all addresses you have access to
Return Type
- GetAllAddressesResponse|error - successful operation
addAddress![](/images/permalink.svg)
function addAddress(AddAddressRequest payload) returns Response|error
Claim a new Mailscript address
Parameters
- payload AddAddressRequest - Address body
deleteAddress![](/images/permalink.svg)
Delete a mailscript address
Parameters
- address string - ID of address
getAllKeys![](/images/permalink.svg)
function getAllKeys(string address) returns GetAllKeysResponse|error
List address keys
Parameters
- address string - ID of address
Return Type
- GetAllKeysResponse|error - successful operation
addKey![](/images/permalink.svg)
function addKey(string address, AddKeyRequest payload) returns AddKeyResponse|error
Add address key
Return Type
- AddKeyResponse|error - successful operation
getKey![](/images/permalink.svg)
Get address key
updateKey![](/images/permalink.svg)
function updateKey(string address, string 'key, UpdateKeyRequest payload) returns Key|error
Update an address key
deleteKey![](/images/permalink.svg)
Delete address key
getDaemonToken![](/images/permalink.svg)
function getDaemonToken(string daemon) returns InlineResponse200|error
Get a token for opening a daemon connection
Parameters
- daemon string - name of Daemon
Return Type
- InlineResponse200|error - Successful get operation
getAllDomains![](/images/permalink.svg)
function getAllDomains() returns GetAllDomainsResponse|error
Get all domains you have access to
Return Type
- GetAllDomainsResponse|error - successful operation
addDomain![](/images/permalink.svg)
function addDomain(AddDomainRequest payload) returns DomainResponse|error
Claim a new Domain
Parameters
- payload AddDomainRequest - Domain body
Return Type
- DomainResponse|error - successful operation
getDomainVerify![](/images/permalink.svg)
function getDomainVerify(string domain) returns DomainResponse|error
Get domain verification
Parameters
- domain string - Full Top-level domain name
Return Type
- DomainResponse|error - successful operation
checkDomainVerify![](/images/permalink.svg)
function checkDomainVerify(string domain) returns CheckDomainVerify|error
Check a new Domain
Parameters
- domain string - Full Top-level domain name
Return Type
- CheckDomainVerify|error - successful operation
removeDomainVerify![](/images/permalink.svg)
Remove a domain
Parameters
- domain string - Full Top-level domain name
getAllInputs![](/images/permalink.svg)
function getAllInputs(string? name) returns GetAllInputsResponse|error
Get all inputs you have access to
Parameters
- name string? (default ()) - Name
Return Type
- GetAllInputsResponse|error - successful operation
getAllIntegrations![](/images/permalink.svg)
function getAllIntegrations() returns GetAllIntegrationsResponse|error
Get all integrations for the user
Return Type
- GetAllIntegrationsResponse|error - Successful operation
deleteIntegration![](/images/permalink.svg)
Delete an integration
Parameters
- integration string - ID of the integration
send![](/images/permalink.svg)
function send(SendRequest payload) returns Response|error
Send an email
Parameters
- payload SendRequest - request body
getAllTriggers![](/images/permalink.svg)
function getAllTriggers() returns GetAllTriggersResponse|error
Get all triggers you have access to
Return Type
- GetAllTriggersResponse|error - successful operation
addTrigger![](/images/permalink.svg)
function addTrigger(AddTriggerRequest payload) returns AddTriggerResponse|error
Setup a trigger
Parameters
- payload AddTriggerRequest - Trigger body
Return Type
- AddTriggerResponse|error - successful add operation
updateTrigger![](/images/permalink.svg)
function updateTrigger(string trigger, AddTriggerRequest payload) returns Response|error
Update a trigger
deleteTrigger![](/images/permalink.svg)
Delete a trigger
Parameters
- trigger string - ID of the trigger
getAuthenticatedUser![](/images/permalink.svg)
Get the authenticated user
updateUser![](/images/permalink.svg)
function updateUser(UpdateUserRequest payload) returns Response|error
Update a user
Parameters
- payload UpdateUserRequest - User body
getAllVerifications![](/images/permalink.svg)
function getAllVerifications() returns GetAllVerificationsResponse|error
Get all verificats for the user
Return Type
- GetAllVerificationsResponse|error - Successful operation
addVerification![](/images/permalink.svg)
function addVerification(VerificationsBody payload) returns AddVerificationResponse|error
Start verification process for external email address or sms number
Parameters
- payload VerificationsBody - Key body
Return Type
- AddVerificationResponse|error - Successful operation
verify![](/images/permalink.svg)
function verify(string verification, VerificationVerifyBody payload) returns Response|error
Verify an email address or sms number with a code
Parameters
- verification string - ID of the verification entry
- payload VerificationVerifyBody - Verify action body
getAllWorkflows![](/images/permalink.svg)
function getAllWorkflows() returns GetAllWorkflowsResponse|error
Get all workflows you have access to
Return Type
- GetAllWorkflowsResponse|error - successful operation
addWorkflow![](/images/permalink.svg)
function addWorkflow(AddWorkflowRequest payload) returns Response|error
Setup workflow
Parameters
- payload AddWorkflowRequest - Workflow body
setWorkflow![](/images/permalink.svg)
function setWorkflow(SetWorkflowRequest payload) returns Response|error
Set a property on a workflow
Parameters
- payload SetWorkflowRequest - Set Workflow body
updateWorkflow![](/images/permalink.svg)
function updateWorkflow(string workflow, AddWorkflowRequest payload) returns Response|error
Update an workflow
deleteWorkflow![](/images/permalink.svg)
Delete a workflow
Parameters
- workflow string - ID of the workflow
getAllWorkspaces![](/images/permalink.svg)
function getAllWorkspaces() returns GetAllWorkspacesResponse|error
Get all workspaces you have access to
Return Type
- GetAllWorkspacesResponse|error - successful operation
addWorkspace![](/images/permalink.svg)
function addWorkspace(AddWorkspaceRequest payload) returns Response|error
Claim a Mailscript workspace
Parameters
- payload AddWorkspaceRequest - request body
Records![](/images/permalink.svg)
mailscript: ActionCombine![](/images/permalink.svg)
Fields
- createdAt string -
- createdBy string -
- id string -
- list string[]? -
- name string -
- owner string -
mailscript: ActionSend![](/images/permalink.svg)
Fields
- config ActionsendConfig -
- createdAt string -
- createdBy string -
- id string -
- name string -
- output string -
- owner string -
mailscript: ActionsendConfig![](/images/permalink.svg)
Fields
- html string? -
- subject string -
- text string? -
- 'type string -
mailscript: AddActionAliasRequest![](/images/permalink.svg)
Fields
- config AddactionaliasrequestConfig -
- name string -
- 'type string -
mailscript: AddactionaliasrequestConfig![](/images/permalink.svg)
Fields
- alias string? -
- 'type string? -
mailscript: AddActionCombineRequest![](/images/permalink.svg)
Fields
- list string[] -
- name string -
mailscript: AddActionDaemonRequest![](/images/permalink.svg)
Fields
- config AddactiondaemonrequestConfig -
- name string -
- 'type string -
mailscript: AddactiondaemonrequestConfig![](/images/permalink.svg)
Fields
- body string -
- daemon string? -
mailscript: AddActionForwardRequest![](/images/permalink.svg)
Fields
- config AddactionforwardrequestConfig -
- name string -
- 'type string -
mailscript: AddactionforwardrequestConfig![](/images/permalink.svg)
Fields
- forward string -
- 'from string -
- 'key string -
- 'type string -
mailscript: AddActionReplyAllRequest![](/images/permalink.svg)
Fields
- config AddactionreplyallrequestConfig -
- name string -
- 'type string -
mailscript: AddactionreplyallrequestConfig![](/images/permalink.svg)
Fields
- 'from string -
- html string? -
- 'key string -
- text string? -
- 'type string -
mailscript: AddActionReplyRequest![](/images/permalink.svg)
Fields
- config AddactionreplyrequestConfig -
- name string -
- 'type string -
mailscript: AddactionreplyrequestConfig![](/images/permalink.svg)
Fields
- 'from string -
- html string? -
- 'key string -
- text string? -
- 'type string -
mailscript: AddActionResponse![](/images/permalink.svg)
Fields
- id string -
mailscript: AddActionSendRequest![](/images/permalink.svg)
Fields
- config AddactionsendrequestConfig -
- name string -
- 'type string -
mailscript: AddactionsendrequestConfig![](/images/permalink.svg)
Fields
- 'from string -
- html string? -
- 'key string -
- subject string -
- text string? -
- to string? -
- 'type string? -
mailscript: AddActionSmsRequest![](/images/permalink.svg)
Fields
- config AddactionsmsrequestConfig -
- name string -
- 'type string -
mailscript: AddactionsmsrequestConfig![](/images/permalink.svg)
Fields
- number string -
- text string -
mailscript: AddActionWebhookRequest![](/images/permalink.svg)
Fields
- config AddactionwebhookrequestConfig -
- name string -
- 'type string -
mailscript: AddactionwebhookrequestConfig![](/images/permalink.svg)
Fields
- body string -
- url string -
mailscript: AddactionwebhookrequestConfigOpts![](/images/permalink.svg)
Fields
- headers record {} -
- method string -
mailscript: AddAddressRequest![](/images/permalink.svg)
Fields
- address string -
mailscript: AddDomainRequest![](/images/permalink.svg)
Fields
- domain string -
mailscript: AddEmailVerificationRequest![](/images/permalink.svg)
Fields
- email string -
- 'type string -
mailscript: AddKeyRequest![](/images/permalink.svg)
Fields
- name string -
- read boolean -
- write boolean -
mailscript: AddKeyResponse![](/images/permalink.svg)
Fields
- id string? -
mailscript: Address![](/images/permalink.svg)
Fields
- createdAt string -
- createdBy string -
- displayName string? -
- id string -
- owner string -
mailscript: AddSmsVerificationRequest![](/images/permalink.svg)
Fields
- sms string -
- 'type string -
mailscript: AddTriggerRequest![](/images/permalink.svg)
Fields
- criteria Criteria|CriteriaOperand -
- name string -
mailscript: AddTriggerResponse![](/images/permalink.svg)
Fields
- id string -
mailscript: AddVerificationResponse![](/images/permalink.svg)
Fields
- id string -
mailscript: AddWorkflowRequest![](/images/permalink.svg)
Fields
- action string -
- active boolean? -
- input string -
- name string -
- trigger string? -
mailscript: AddWorkspaceRequest![](/images/permalink.svg)
Fields
- workspace string -
mailscript: CheckDomainVerify![](/images/permalink.svg)
Fields
- domain string -
- success boolean -
mailscript: ClientHttp1Settings![](/images/permalink.svg)
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![](/images/permalink.svg)
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-forwarded
header
- 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![](/images/permalink.svg)
Fields
- domain string? -
- 'from string? -
- hasAttachments boolean? -
- hasTheWords string? -
- sentTo string? -
- subjectContains string? -
mailscript: CriteriaOperand![](/images/permalink.svg)
Fields
- and string[]? -
- or string[]? -
mailscript: DomainResponse![](/images/permalink.svg)
Fields
- domain string -
- records DomainresponseRecords[] -
mailscript: DomainresponseRecords![](/images/permalink.svg)
Fields
- name string -
- 'type string -
- value string -
mailscript: ErrorResponse![](/images/permalink.svg)
Fields
- 'error string -
mailscript: GetAllActionsResponse![](/images/permalink.svg)
Fields
- list (ActionSend|ActionCombine)[] -
mailscript: GetAllAddressesResponse![](/images/permalink.svg)
Fields
- list (Address)[] -
mailscript: GetAllDomainsResponse![](/images/permalink.svg)
Fields
- id string[]? -
mailscript: GetAllInputsResponse![](/images/permalink.svg)
Fields
- list (MailscriptEmailInput)[] -
mailscript: GetAllIntegrationsResponse![](/images/permalink.svg)
Fields
- list (Integration)[] -
mailscript: GetAllKeysResponse![](/images/permalink.svg)
Fields
- list (Key)[] -
mailscript: GetAllTriggersResponse![](/images/permalink.svg)
Fields
- list (Trigger)[] -
mailscript: GetAllVerificationsResponse![](/images/permalink.svg)
Fields
- list (VerificationEmail|VerificationSms)[] -
mailscript: GetAllWorkflowsResponse![](/images/permalink.svg)
Fields
- list (Workflow)[] -
mailscript: GetAllWorkspacesResponse![](/images/permalink.svg)
Fields
- list (Workspace)[] -
mailscript: InlineResponse200![](/images/permalink.svg)
Fields
- token string -
mailscript: Integration![](/images/permalink.svg)
Fields
- createdAt string -
- id string -
- 'type string -
mailscript: Key![](/images/permalink.svg)
Fields
- createdAt string -
- createdBy string -
- id string -
- name string -
- read boolean -
- write boolean -
mailscript: KeyValuePair![](/images/permalink.svg)
Fields
- 'key string -
- value string -
mailscript: MailscriptEmailInput![](/images/permalink.svg)
Fields
- address string -
- createdAt string -
- createdBy string -
- id string -
- name string -
- owner string -
- 'type string -
mailscript: ProxyConfig![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- 'from string -
- html string? -
- subject string -
- text string? -
- to string -
mailscript: SetWorkflowRequest![](/images/permalink.svg)
Fields
- id string? -
- pairs (KeyValuePair)[]? -
mailscript: Trigger![](/images/permalink.svg)
Fields
- createdAt string -
- createdBy string -
- criteria Criteria -
- displayName string? -
- id string -
- name string -
- owner string -
mailscript: UpdateKeyRequest![](/images/permalink.svg)
Fields
- name string -
- read boolean -
- write boolean -
mailscript: UpdateUserRequest![](/images/permalink.svg)
Fields
- displayName string -
mailscript: User![](/images/permalink.svg)
Fields
- createdAt string -
- displayName string -
- email string -
- id string -
- photoURL string? -
mailscript: VerificationEmail![](/images/permalink.svg)
Fields
- email string? -
- id string? -
- 'type string? -
- verified boolean? -
- verifiedAt string? -
- verifiedBy string? -
mailscript: VerificationSms![](/images/permalink.svg)
Fields
- id string? -
- sms string? -
- 'type string? -
- verified boolean? -
- verifiedAt string? -
- verifiedBy string? -
mailscript: VerifyEmailRequest![](/images/permalink.svg)
Fields
- code string -
- email string -
mailscript: VerifySmsRequest![](/images/permalink.svg)
Fields
- code string -
- sms string -
mailscript: Workflow![](/images/permalink.svg)
Fields
- action string -
- active boolean? -
- createdAt string -
- createdBy string -
- id string -
- input string -
- name string -
- owner string -
- trigger string -
mailscript: Workspace![](/images/permalink.svg)
Fields
- createdAt string -
- createdBy string -
- id string -
- owner string -
Union types![](/images/permalink.svg)
mailscript: ActionsActionBody![](/images/permalink.svg)
ActionsActionBody
mailscript: ActionsBody![](/images/permalink.svg)
ActionsBody
mailscript: VerificationsBody![](/images/permalink.svg)
VerificationsBody
mailscript: VerificationVerifyBody![](/images/permalink.svg)
VerificationVerifyBody
Import
import ballerinax/mailscript;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Communication/Mail
Cost/Paid
Contributors
Dependencies