JangoMail API and Web Service

The following operations are supported. For a formal definition, please review the Service Description.

Expand All - Collapse All

- Campaign Sending

ApproveMassEmail
Approves a campaign that is currently pending approval. Returns a string.
DeleteMassEmail
Deletes an unsent campaign or an already sent campaign from your account. Returns a string.
PauseMassEmail
Pauses a campaign. Returns a string.
ResumeMassEmail
Resumes a paused campaign. Returns a string.
SendMassEmail
Sends a campaign with a plain text and/or HTML email. Returns a string.
SendMassEmailPrevious
Sends a previously saved campaign to a new set of recipients. Returns a string.
SendMassEmailPrevious2
Sends a previously saved campaign to a new set of recipients. Returns a string.
SendMassEmailRaw
Sends a campaign, given a raw message including MIME parts and a MIME boundary. Returns a string.

- Transactional Sending

AddTransactionalGroup
Adds a new transactional group. Returns a string.
DeleteTransactionalGroup
Deletes a transactional group from your account. Returns a string.
GetTransactionalGroupID
Retrieves a transactional group ID. Returns a string.
SendTransactionalEmail
Sends a transactional email message to a single recipient, includes full tracking and DKIM signing capabilities. Returns a string.
SendTransactionalEmailFromTemplate
Sends a transactional email message to a single recipient, based on a saved email template, includes full tracking and DKIM signing capabilities. Returns a string.
SMTPRelay_AddIP
Adds a new authenticated IP address. Retuns a string.
SMTPRelay_DeleteIP
Deletes an existing authenticated IP address. Returns a string.
TransactionalGroups_Rename
Renames a transactional group. Returns a string.

- Campaign Reporting

GetCampaignDeliveryLog_XML
Retrieves the delivery logs for recipients of a campaign.
GetCampaignDetails_XML
Retrieves the details of a campaign.
GetMassEmailReport
Retrieves reporting statistics on a particular campaign. Returns an array of integers.
GetMassEmailReport_Multiple_String
Retrieves reporting statistics for a set of campaigns based on date range. Returns a string of integers.
GetMassEmailReport2
Retrieves reporting statistics on a particular campaign, including blocks. Returns an array of integers.
GetMassEmailStatus
Retrieves the status for a particular campaign. Returns a string.
GetMassEmailStatus_CustomCampaignID
Retrieves the status for a particular campaign. Returns a string.
GetSpamScore
Retrieves the spam score for a campaign. Returns a string.
GetViewAsWebPageURL
Generates a view as webpage URL for a campaign. Returns a string.
Reports_Broadcast_GetBlocks
Retrieves block data for a particular campaign. Returns a string.
Reports_GetAllClicks_DataSet
Retrieves list of recipients that have clicked a link in a particular campaign. Returns a .NET DataSet.
Reports_GetAllClicks_String
Retrieves list of recipients that have clicked a link in a particular campaign. Returns a string.
Reports_GetAllClicks_XML
Retrieves list of recipients that have clicked a link in a particular campaign. Returns an XML document.
Reports_GetBouncesByCampaign_DataSet
Retrieves list of bounced addresses for a particular campaign. Returns a .NET DataSet.
Reports_GetBouncesByCampaign_DataSet2
Retrieves list of bounced addresses for a particular campaign, including SMTP Code and Definitive columns. Returns a .NET DataSet.
Reports_GetBouncesByCampaign_String
Retrieves list of bounced addresses for a particular campaign. Returns a string.
Reports_GetBouncesByCampaign_String2
Retrieves list of bounced addresses for a particular campaign, including SMTP Code and Definitive columns. Returns a string.
Reports_GetBouncesByCampaign_XML
Retrieves list of bounced addresses for a particular campaign. Returns an XML document.
Reports_GetBouncesByCampaign_XML2
Retrieves list of bounced addresses for a particular campaign, including SMTP Code and Definitive columns. Returns an XML document.
Reports_GetClicksByURL_DataSet
Retrieves list of recipients that have clicked a particular link in a particular campaign. Returns a .NET DataSet.
Reports_GetClicksByURL_String
Retrieves list of recipients that have clicked a particular link in a particular campaign. Returns a string.
Reports_GetClicksByURL_XML
Retrieves list of recipients that have clicked a particular link in a particular campaign. Returns an XML document.
Reports_GetComplaintsAll_DataSet
Retrieves list of complaints within a date range. Returns a .NET DataSet.
Reports_GetComplaintsAll_String
Retrieves list of complaints within a date range. Returns a string.
Reports_GetComplaintsAll_XML
Retrieves list of complaints within a date range. Returns an XML Document.
Reports_GetComplaintsByCampaign_Dataset
Retrieves list of complaints for a particular campaign. Returns a .NET DataSet.
Reports_GetComplaintsByCampaign_String
Retrieves list of complaints for a particular campaign. Returns a string.
Reports_GetComplaintsByCampaign_XML
Retrieves list of complaints for a particular campaign. Returns an XML document.
Reports_GetMailboxFull_Dataset
Retrieves the "mailbox full" soft bounces for a particular campaign. Returns a .NET DataSet.
Reports_GetMailboxFull_String
Retrieves the "mailbox full" soft bounces for a particular campaign. Returns a string.
Reports_GetMailboxFull_XML
Retrieves the "mailbox full" soft bounces for a particular campaign. Returns an XML document.
Reports_GetMassEmailInformation_DataSet
Retrieves campaign details for a particular date range. Returns a .NET DataSet.
Reports_GetMassEmailInformation_DataSet2
Retrieves campaign details for a particular date range, including Campaign Identifier. Returns a .NET DataSet.
Reports_GetMassEmailInformation_DataSet3
Retrieves campaign details for a particular date range, including Campaign Identifier, from email and from name. Returns a .NET DataSet.
Reports_GetMassEmailInformation_String
Retrieves campaign details for a particular date range. Returns a string.
Reports_GetMassEmailInformation_String2
Retrieves campaign details for a particular date range, including Campaign Identifier. Returns a string.
Reports_GetMassEmailInformation_String3
Retrieves campaign details for a particular date range, including Campaign Identifier, from email and from name. Returns a string.
Reports_GetMassEmailInformation_XML
Retrieves campaign details for a particular date range. Returns an XML document.
Reports_GetMassEmailInformation_XML2
Retrieves campaign details for a particular date range, including Campaign Identifier. Returns an XML document.
Reports_GetMassEmailInformation_XML3
Retrieves campaign details for a particular date range, including Campaign Identifier, from email and from name. Returns an XML document.
Reports_GetOpens_DataSet
Retrieves list of recipients that have opened a particular campaign. Returns a .NET DataSet.
Reports_GetOpens_String
Retrieves list of recipients that have opened a particular campaign. Returns a string.
Reports_GetOpens_XML
Retrieves list of recipients that have opened a particular campaign. Returns an XML document.
Reports_GetRecipients_DataSet
Retrieves list of recipients for a particular campaign. Returns a .NET DataSet.
Reports_GetRecipients_String
Retrieves list of recipients for a particular campaign. Returns a string.
Reports_GetRecipients_XML
Retrieves list of recipients for a particular campaign. Returns an XML document.
Reports_GetRemovedAddresses
Retrieves a list of addresses which have been removed during preprocessing for a particular campaign. Returns a JSON String.
Reports_GetSentMessageCount
Retrieves number of sent messages for a particular date range. Returns an integer
Reports_GetSMTPLog
Retrieves the SMTP log for the specified campaign recipient. Returns a string.
Reports_GetUnsubscribesAll_DataSet
Retrieves list of unsubscribed addresses for all campaigns for a particular date range. Returns a .NET DataSet.
Reports_GetUnsubscribesAll_DataSet2
Retrieves list of unsubscribed addresses for all campaigns. Returns a .NET DataSet.
Reports_GetUnsubscribesAll_String
Retrieves list of unsubscribed addresses for all campaigns. Returns a string.
Reports_GetUnsubscribesAll_String2
Retrieves list of unsubscribed addresses for all campaigns for a particular date range. Returns a string.
Reports_GetUnsubscribesAll_XML
Retrieves list of unsubscribed addresses for all campaigns. Returns an XML document.
Reports_GetUnsubscribesAll_XML2
Retrieves list of unsubscribed addresses for all campaigns for a particular date range. Returns an XML document.
Reports_GetUnsubscribesByCampaign_DataSet
Retrieves list of unsubscribed addresses for a particular campaign. Returns a .NET DataSet.
Reports_GetUnsubscribesByCampaign_String
Retrieves list of unsubscribed addresses for a particular campaign. Returns a string.
Reports_GetUnsubscribesByCampaign_XML
Retrieves list of unsubscribed addresses for a particular campaign. Returns an XML document.

- Group / Email List Management

AddGroup
Adds a new list. Returns a string.
AddGroupField
Adds a standard field to the specified list. Returns a string.
AddGroupMember
Adds a member to the specified list, via array input. Returns a string.
AddGroupMemberString
Adds a member to the specified list, via string input. Returns a string.
DeleteGroupByID
Deletes a list given its ID number. Returns a string.
DeleteGroupByName
Deletes a list given its name. Returns a string.
DeleteGroupField
Removes a field from the specified list. Returns a string.
DeleteGroupMember
Deletes a list member from the specified list. Returns a string.
GetGroupFieldList
Gets the list of all fields in the specified list. Returns a string.
GetGroupMemberCount
Gets the number of members in a list. Returns an integer.
Groups_DeleteAllMembers
Deletes all members of a list.
Groups_DeleteBulkMembers
Deletes all specified email addresses in a list. Returns a string.
Groups_EditMember_ByAddress
Updates a field for a list member. Returns a string
Groups_EditMember_ByID
Updates a field for a list member. Returns a string
Groups_GetList_DataSet
Retrieves list of all lists in account. Returns a .NET DataSet.
Groups_GetList_String
Retrieves list of all lists in account. Returns a string.
Groups_GetList_XML
Retrieves list of all lists in account. Returns an XML document.
Groups_GetMember_ByAddress_DataSet
Retrieves a list member by the member's email address. Returns a .NET DataSet.
Groups_GetMember_ByAddress_XML
Retrieves a list member by the member's email address. Returns an XML document.
Groups_GetMember_ByID_DataSet
Retrieves a list member by the member's numeric ID. Returns a .NET DataSet.
Groups_GetMember_ByID_XML
Retrieves a list member by the member's numeric ID. Returns an XML document.
Groups_GetMembers_DataSet
Retrieves members of a list Returns a .NET DataSet.
Groups_GetMembers_String
Retrieves members of a list Returns a string
Groups_GetMembers_XML
Retrieves members of a list Returns a string
Groups_Rename
Renames a list. Returns a string.
ImportGroupMembersFromData
Imports members into a list from raw data. Returns a string.
ImportGroupMembersFromData2
Imports members into a list from raw data. Specify whether to add all records or update existing records. Returns a string.
ImportGroupMembersFromFile
Imports members into a list from previously FTPd file. Returns a string.
ImportGroupMembersFromFile2
Imports members into a list from previously FTPd file. Specify whether to add all records or update existing records. Returns a string.
IsMemberInGroup
Determines whether a particular email address is in a list. Returns a boolean true/false.
Lists_EditMember_ByAddress
Edits a list member. Returns a string.
MergeEmailLists
Merges two email lists by copying the list members from the source list to the destination list. Returns a string.
VerifyEmailAddress
Verifies a single email address. Returns a .NET DataSet.

- Unsubscribe Management

AddUnsubscribe
Adds a single email address to the unsubscribe list. Returns a string.
CheckUnsubscribe
Checks unsubscribe list for presence of specified email address. Returns a string.
DeleteUnsubscribe
Removes a single email address from the unsubscribe list. Returns a string.
GetUnsubscribeList
Retrieves list of unsubscribed email addresses since the specified date. Returns a string.
GetUnsubscribeList2
Retrieves list of unsubscribed email addresses and date since the specified date. Returns a string.

- Bounce Management

CheckBounce
Checks if email address is on the bounce list. Returns a string.
DeleteBounce
Removes an email address from the bounce list. Returns a string.
GetBounceListAll
Retrieves list of all email addresses that have bounced at least once since the specified date. Returns a string.
GetBounceListAll2
Retrieves data of all email addresses that have bounced at least once since the specified date. Returns a string.
GetBounceListNormal
Retrieves list of email addresses that have bounced X times since specified date, where X is a configurable parameter in your account. Returns a string.
GetBounceListNormal_IncludePast
Retrieves list of email addresses that have bounced at least X times in total, and at least once since specified date, where X is a configurable parameter in your account. Returns a string.
GetBounceListNormal_IncludePast2
Retrieves list of email addresses that have bounced at least X times in total, and at least once since specified date, where X is a configurable parameter in your account. Returns a string.
GetBounceListNormal2
Retrieves list of email addresses that have bounced X times since specified date, where X is a configurable parameter in your account. Returns a string.
Reports_GetSoftBouncesByCount_DataSet
Retrieves list of email addresses which have bounced greater than or equal to value, within the specified time range. Returns a .NET DataSet.
Reports_GetSoftBouncesByCount_String
Retrieves list of email addresses which have bounced greater than or equal to value, within the specified time range. Returns a string.
Reports_GetSoftBouncesByCount_XML
Retrieves list of email addresses which have bounced greater than or equal to value, within the specified time range. Returns an XML document.

- Transactional Reporting

ClearSMTPErrors
Clears SMTP errors from account. Returns a string.
GetTransactionalDeliveryLog_XML
Retrieves the delivery log for a transactional message. Returns and XML document.
GetTransactionalIDsFromCustomID
Retrieves the transactional ID given a user-specified custom ID for a transactional email. Returns an XML document.
GetTransactionalIDsFromRelayID
Retrieves the transactional ID given the SMTP-relay-generated ID for a transactional email. Returns an XML document.
Groups_GetTransactionalList_DataSet
Retrieves list of transactional groups in account. Returns a .NET DataSet.
Groups_GetTransactionalList_String
Retrieves list of transactional groups in account. Returns a string.
Groups_GetTransactionalList_XML
Retrieves list of transactional groups in account. Returns an XML document.
Reports_GetBouncesByTransactionalGroup_DataSet
Retrieves list of bounced addresses for a particular transactional group. Returns a .NET DataSet.
Reports_GetBouncesByTransactionalGroup_DataSet2
Retrieves list of bounced addresses for a particular transactional group between a date range. Returns a .NET DataSet.
Reports_GetBouncesByTransactionalGroup_String
Retrieves list of bounced addresses for a particular transactional group. Returns a string.
Reports_GetBouncesByTransactionalGroup_String2
Retrieves list of bounced addresses for a particular transactional group between a date range. Returns a string.
Reports_GetBouncesByTransactionalGroup_XML
Retrieves list of bounced addresses for a particular transactional group. Returns an XML document.
Reports_GetBouncesByTransactionalGroup_XML2
Retrieves list of bounced addresses for a particular transactional group between a date range. Returns an XML document.
Reports_GetBouncesByTransactionalGroupWithId_DataSet
Retrieves list of bounced addresses for a particular transactional group. Returns a .NET DataSet.
Reports_GetBouncesByTransactionalGroupWithId_String
Retrieves list of bounced addresses for a particular transactional group. Returns a string.
Reports_GetBouncesByTransactionalGroupWithId_XML
Retrieves list of bounced addresses for a particular transactional group. Returns an XML document.
Reports_GetComplaintsByTransactionalGroup_DataSet
Retrieves list of complaints for a particular transactional group between a date range. Returns a .NET DataSet.
Reports_GetComplaintsByTransactionalGroup_String
Retrieves list of complaints for a particular transactional group between a date range. Returns a string.
Reports_GetComplaintsByTransactionalGroup_XML
Retrieves list of complaints for a particular transactional group between a date range. Returns an XML document.
Reports_GetSMTPLog_Transactional
Retrieves the SMTP log for a transactional message. Returns a string.
Reports_Transactional_GetBlocks
Retrieves list of blocks for a particular transactional group between a date range. Returns a string.
Reports_Transactional_GetClicks_DataSet
Retrieves list of clicks for a particular transactional group between a date range. Returns a .Net DataSet.
Reports_Transactional_GetClicks_String
Retrieves list of clicks for a particular transactional group between a date range. Returns a string.
Reports_Transactional_GetClicks_XML
Retrieves list of clicks for a particular transactional group between a date range. Returns an XML document.
Reports_Transactional_GetMessages_Dataset
Retrieves list of transactional messages between a date range. Returns a .NET DataSet.
Reports_Transactional_GetMessages_String
Retrieves list of transactional messages between a date range. Returns a string.
Reports_Transactional_GetMessages_XML
Retrieves list of transactional messages between a date range. Returns an XML document.
Reports_Transactional_GetOpens_DataSet
Retrieves list of opens for a particular transactional group between a date range. Returns a .NET DataSet.
Reports_Transactional_GetOpens_String
Retrieves list of opens for a particular transactional group between a date range. Returns a string.
Reports_Transactional_GetOpens_XML
Retrieves list of opens for a particular transactional group between a date range. Returns an XML document.
Reports_Transactional_GetRecipients_DataSet
Retrieves list of transactional messages for a particular transactional group between a date range. Returns a .NET DataSet.
Reports_Transactional_GetRecipients_String
Retrieves list of transactional messages for a particular transactional group between a date range. Returns a string.
Reports_Transactional_GetRecipients_XML
Retrieves list of transactional messages for a particular transactional group between a date range. Returns an XML document.
Reports_Transactional_GetReport_XML
Retrieves statistics for a transactional group. Returns an XML document.
Reports_Transactional_GetReport_XML2
Retrieves all statistics for a transactional group. Returns an XML document.
Reports_Transactional_GetSingleEmailStats_Dataset
Retrieves statistics for a transactional email. Returns a .NET DataSet.
Reports_Transactional_GetSingleEmailStats_String
Retrieves statistics for a transactional email. Returns a string.
Reports_Transactional_GetSingleEmailStats_XML
Retrieves statistics for a transactional email. Returns an XML document.
Reports_Transactional_GetSMTPErrors_DataSet
Retrieves list of SMTP errors. Returns a .NET DataSet.
Reports_Transactional_GetSMTPErrors_DataSet2
Retrieves list of SMTP errors for a particular date range. Returns a .NET DataSet.
Reports_Transactional_GetSMTPErrors_String
Retrieves list of SMTP errors. Returns a string.
Reports_Transactional_GetSMTPErrors_String2
Retrieves list of SMTP errors for a particular date range. Returns a string.
Reports_Transactional_GetSMTPErrors_XML
Retrieves list of SMTP errors. Returns an XML document.
Reports_Transactional_GetSMTPErrors_XML2
Retrieves list of SMTP errors for a particular date range. Returns an XML document.

- Account Management

AuthenticateUser
Authenticates a user login. Returns a string.
ChangeSubAccountPassword
Changes the password of a subaccount. Retuns a string.
CreateAPIToken
Creates a new API Token. Returns a string.
CreateSubAccount
Creates a new subaccount. Returns a string.
DeleteAPIToken
Deletes an API token. Returns a string.
DeleteAsset
Deletes a file. Returns a string.
DeleteAttachment
Deletes an attachment. Returns a string.
GetTrackingDomain
Retrieves account's tracking domain. Returns a string.
ListAssets
Lists all files. Returns a string.
ListAttachments
Lists all attachments. Returns a string.
Reports_GetAccountUsage_String
Retrieves statistics for current account usage. Returns a string.
Reports_GetAccountUsage_XML
Retrieves statistics for current account usage. Returns an XML document.
SetTrackingDomain
Sets tracking domain. Returns a string.
UploadAsset
Upload file. Returns a string.
UploadAssetFromBase64
Upload file. Returns a string.
UploadAttachment
Upload an attachment. Returns a string.
UploadAttachmentFromBase64
Upload an attachment. Returns a string.