← Back to API List

email - addsmtpserver

Adds a SMTP Server for use in remote SMTP Campaigns

API Call Information

area: email

action: addsmtpserver

API Arguments

Argument	Data Type	Required	Description
smtpserver	string	Yes	SMTP Server Host. A domain name.
smtpport	integer	Yes	Port number for SMTP Server
username	string	Yes	SMTP Username
password	string	Yes	SMTP Server password
testemailaddress	string	Yes	An email address to send on behalf of to test that connection works.
emailaddress	string	No	Email address to send on behalf. If empty we assume any email you entered will be allowed to used. Normally empty if using another ESP for remote campaigns.
sslmode	string	No	either empty or ssl or tls.

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=addsmtpserver

API Response

XML Response

<response>
  <success>SMTP server Added</success>
  <smtpserverid>122</smtpserverid>
</response>

JSON Response

{
    "success": "SMTP server Added",
    "smtpserverid": "122"
}