JangoMail Application Programming Interface (API) and Web Service
The JangoMail Application Programming Interface (API) is a web service that allows you to control your JangoMail account programatically via an HTTP POST, an HTTP GET, or an XML-based SOAP call. The supported methods are shown below. Documentation on the API includes the tutorial on using the API, and a web-based reference on all available methods and their signatures.
The API is frequently updated with new methods and e-mail notifications are sent to people on the JangoMail API e-mail list. To join the API e-mail list click here.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddBounce
Adds a single e-mail address to your bounce list. Returns a string. -
AddGroup
Adds a new Group to your account. Returns a string. -
AddGroupField
Adds a standard field to the specified Group. Returns a string. -
AddGroupField_Big
Adds a large text storage field to the specified Group. Returns a string. -
AddGroupMember
Adds a member to the specified Group, via array input. Returns a string. -
AddGroupMemberString
Adds a member to the specified Group, via string input. Returns a string. -
AddUnsubscribe
Adds a single e-mail address to your unsubscribe list. Returns a string. -
CheckBounce
Checks for the presence of the specified e-mail address in the bounce list. Returns a string. -
CheckUnsubscribe
Checks unsubscribe list for presence of specified e-mail address. Returns a string. -
CreateAccount
Creates a user account. Returns the User ID for the new user account. -
CreateLocalDBProfile
Creates a local database profile. -
DeleteBounce
Removes a single e-mail address from the bounce list. Returns a string. -
DeleteGroupByID
Deletes a Group given its ID number. Returns a string. -
DeleteGroupByName
Deletes a Group given its name. Returns a string. -
DeleteGroupField
Removes a field from the specified Group. Returns a string. -
DeleteGroupMember
Deletes a Group member from the specified Group. Returns a string. -
DeleteMassEmail
Deletes an unsent scheduled mass e-mail or an already sent mass e-mail from your account. Returns a string. -
DeleteUnsubscribe
Removes a single e-mail address from the unsubscribe list. Returns a string. -
GetBounceListAll
Gets the list of all e-mail addresses that have bounced at least once since the specified date. Returns a string. -
GetBounceListAll2
Gets the list of all e-mail addresses that have bounced at least once since the specified date. Includes SMTP Diagnostic Code and Definitive columns. Returns a string. -
GetBounceListNormal
Gets the list of e-mail addresses that have bounced X times since specified date, where X is a configurable parameter in your account. Returns a string. -
GetBounceListNormal2
Gets the list of e-mail addresses that have bounced X times since specified date, where X is a configurable parameter in your account. Includes SMTP Diagnostic Code and Definitive columns. Returns a string. -
GetBounceListNormal_IncludePast
Gets the list of e-mail addresses that have bounced at least X times in total, and at least once since specified date. X is a configurable parameter in your account. Returns a string. -
GetBounceListNormal_IncludePast2
Gets the list of e-mail addresses that have bounced at least X times in total, and at least once since specified date. X is a configurable parameter in your account. Includes SMTP Diagnostic Code and Definitive columns. Returns a string. -
GetGroupFieldList
Gets the list of all fields in the specified Group. Returns a string. -
GetGroupMemberCount
Gets the number of members in a Group. Returns an integer. -
GetMassEmailReport
Gets the reporting statistics on a particular mass e-mail. Returns an array of integers. -
GetUnsubscribeList
Gets the list of all unsubscribed e-mail addresses since the specified date. Returns a string. -
Groups_EditMember_ByAddress
Updates a field for a group member. Returns a string -
Groups_EditMember_ByID
Updates a field for a Group member. Returns a string -
Groups_GetList_DataSet
Retrieves list of Groups in user's account. Returns a .NET DataSet. -
Groups_GetList_String
Retrieves list of Groups in user's account. Returns a string. -
Groups_GetList_XML
Retrieves list of Groups in user's account. Returns an XML document. -
Groups_GetMember_ByAddress_DataSet
Retrieves a Group member by the member's e-mail address. Returns a .NET DataSet. -
Groups_GetMember_ByAddress_XML
Retrieves a Group member by the member's e-mail address. Returns an XML document. -
Groups_GetMember_ByID_DataSet
Retrieves a Group member by the member's numeric ID. Returns a .NET DataSet. -
Groups_GetMember_ByID_XML
Retrieves a Group member by the member's numeric ID. Returns an XML document. -
Groups_GetMembers_DataSet
Retrieves members of a Group Returns a .NET DataSet. -
Groups_GetMembers_String
Retrieves members of a Group Returns a string -
Groups_GetMembers_XML
Retrieves members of a Group Returns a string -
ImportGroupMembersFromData
Imports members into a Group from raw data. Returns a string. -
ImportGroupMembersFromFile
Imports members into a Group from previously FTPd file. Returns a string. -
IsMemberInGroup
Determines whether a particular e-mail address is in a Group. Returns a boolean true/false. -
Reports_GetAllClicks_DataSet
Retrieves list of recipients that have clicked any link in a mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetAllClicks_String
Retrieves list of recipients that have clicked any link in a mass e-mail campaign. Returns a string. -
Reports_GetAllClicks_XML
Retrieves list of recipients that have clicked any link in a mass e-mail campaign. Returns an XML document. -
Reports_GetBouncesByCampaign_DataSet
Retrieves list of bounced addresses for a particular mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetBouncesByCampaign_DataSet2
Retrieves list of bounced addresses for a particular mass e-mail campaign. Includes SMTP Diagnostic Code and Definitive columns. Returns a .NET DataSet. -
Reports_GetBouncesByCampaign_String
Retrieves list of bounced addresses for a particular mass e-mail campaign. Returns a string. -
Reports_GetBouncesByCampaign_String2
Retrieves list of bounced addresses for a particular mass e-mail campaign. Includes SMTP Diagnostic Code and Definitive columns. Returns a string. -
Reports_GetBouncesByCampaign_XML
Retrieves list of bounced addresses for a particular mass e-mail campaign. Returns an XML document. -
Reports_GetBouncesByCampaign_XML2
Retrieves list of bounced addresses for a particular mass e-mail campaign. Includes SMTP Diagnostic Code and Definitive columns. Returns an XML document. -
Reports_GetClicksByURL_DataSet
Retrieves list of recipients that have clicked a particular link in a mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetClicksByURL_String
Retrieves list of recipients that have clicked a particular link in a mass e-mail campaign. Returns a string. -
Reports_GetClicksByURL_XML
Retrieves list of recipients that have clicked a particular link in a mass e-mail campaign. Returns an XML document. -
Reports_GetForwards_DataSet
Retrieves list of forwarded from and to addresses for a particular mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetForwards_String
Retrieves list of forwarded from and to addresses for a particular mass e-mail campaign. Returns a string. -
Reports_GetForwards_XML
Retrieves list of forwarded from and to addresses for a particular mass e-mail campaign. Returns an XML document. -
Reports_GetMassEmailInformation_DataSet
Retrieves mass e-mail campaign information, including job IDs and subject lines for a particular date range. Returns a .NET DataSet. -
Reports_GetMassEmailInformation_DataSet2
Retrieves mass e-mail campaign information, including job IDs, subject lines, and campaign identifiers for a particular date range. Returns a .NET DataSet. -
Reports_GetMassEmailInformation_String
Retrieves mass e-mail campaign information, including job IDs and subject lines for a particular date range. Returns a string. -
Reports_GetMassEmailInformation_String2
Retrieves mass e-mail campaign information, including job IDs, subject lines, and campaign identifiers for a particular date range. Returns a string. -
Reports_GetMassEmailInformation_XML
Retrieves mass e-mail campaign information, including job IDs and subject lines for a particular date range. Returns an XML document. -
Reports_GetMassEmailInformation_XML2
Retrieves mass e-mail campaign information, including job IDs, subject lines, and campaign identifiers for a particular date range. Returns an XML document. -
Reports_GetOpens_DataSet
Retrieves list of recipients that have opened a mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetOpens_String
Retrieves list of recipients that have opened a mass e-mail campaign. Returns a string. -
Reports_GetOpens_XML
Retrieves list of recipients that have opened a mass e-mail campaign. Returns an XML document. -
Reports_GetRecipients_DataSet
Retrieves list of recipients for a particular mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetRecipients_String
Retrieves list of recipients for a particular mass e-mail campaign. Returns a string. -
Reports_GetRecipients_XML
Retrieves list of recipients for a particular mass e-mail campaign. Returns an XML document. -
Reports_GetReplies_DataSet
Retrieves list of replies for a particular mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetReplies_String
Retrieves list of replies for a particular mass e-mail campaign. Returns a string. -
Reports_GetReplies_XML
Retrieves list of replies for a particular mass e-mail campaign. Returns an XML document. -
Reports_GetSentMessageCount
Retrieves number of sent messages from a particular account within a specified time period. Returns an integer. -
Reports_GetUnsubscribesAll_DataSet
Retrieves list of unsubscribed addresses for all mass e-mail campaigns. Returns a .NET DataSet. -
Reports_GetUnsubscribesAll_String
Retrieves list of unsubscribed addresses for all mass e-mail campaigns. Returns a String. -
Reports_GetUnsubscribesAll_XML
Retrieves list of unsubscribed addresses for all mass e-mail campaigns. Returns an XML document. -
Reports_GetUnsubscribesByCampaign_DataSet
Retrieves list of unsubscribed addresses for a particular mass e-mail campaign. Returns a .NET DataSet. -
Reports_GetUnsubscribesByCampaign_String
Retrieves list of unsubscribed addresses for a particular mass e-mail campaign. Returns a string. -
Reports_GetUnsubscribesByCampaign_XML
Retrieves list of unsubscribed addresses for a particular mass e-mail campaign. Returns an XML document. -
SendMassEmail
Sends a mass e-mail with a plain text and/or HTML e-mail. Returns a string. -
SendMassEmailPrevious
Sends a previously saved mass e-mail to a new set of recipients. Returns a string. -
SendMassEmailPrevious2
Sends a previously saved mass e-mail to a new set of recipients. Returns a string. -
SendMassEmailRaw
Sends a mass e-mail, given a raw message including MIME parts and a MIME boundary. Returns a string.