每天有50万活跃用户信任，在匿名电子邮件交换，应用最高付款安全性和匿名电子邮件交换中最受欢迎的域名方面，世界排名第一。

5yMail.com kindly introduces new API Service for all users worldwide to send email by HTTP POST/GET request. The advantage of the service is to allow user to send a larger number of emails, bulk emails with HTML/Rich content. 

The integration with our API Service is completely simple for both normal internet users and developers. Only a few steps to make API work and integrated into your own system to send bulk emails.

Parameters

Parameters	Required	Type	Description
apiKey	YES	A string	A key generated by 5yMail API Service ater payment. To obtain apiKey at My Credits menu.
authUser	YES	A string	An authenticate user generated by 5yMail API Service ater payment. To obtain authUser at My Credits menu.
toEmail	YES	A valid email address	Recipient's email address, only one email supported
subject	YES	A string of characters without special ones.	The subject of the email to be sent.
lang	NO	A string	The language of API Service that your account created. Refer to My Credits menu for more detail. If it is empty or missing, the default language English( en ) is used, meant that your account was created in English version. Value: en, fr, es, it, de, ru, zh or vi
content	YES	A string	Content of the email to be sent, HTML supported.
html_content	NO	boolean (true/false)	Default: true (HTML supported) or false for plain text
fromEmail	NO	A valid email address	The sender address of the email to be sent. If it is empty or missing, the sender@5ymail.com is used as a default sender.
ccEmail	NO	A valid email address	The CC address of the email to be sent.
bccEmail	NO	A valid email address	The BCC address of the email to be sent.
fromName	NO	A string of characters without special ones	The sender name of the email to be sent.
replyEmail	NO	A valid email address	The email address recipient reply to.  WARNING: - If it is empty or missing, the reply email from recipient will route to your 5yMail's received messages. - If it is included in api request, the reply email from recipient will go to this email address.
replyName	NO	A string	The name for replyEmail defined above.
xMailer	NO	A string	The X-Mailer header to be included in email header.
header1	NO	A string	The custom header to be included in email header.
header2	NO	A string	The custom header to be included in email header.
serverLocation	NO	A string	Specifiy the email server location to send the email. If it not set or empty, the email location will be selected randomly. Value: asia, europe or usa

 

URL requests

POST - https://service.5ymail.com/api

GET - https://service.5ymail.com/api

The service authentication requires the following parameters

apiKey: Refer My Credits to obtain it.
authUser: Refer My Credits to obtain it.

 

HTTP POST method

 POST -  https://service.5ymail.com/api

Body

{
"apiKey": "< apiKey >",
"authUser": "chalovina",
"toEmail": "5ymail.com@gmail.com",
"fromEmail": "sender@5ymail.com",
"fromName": "5yMail Team",
"subject": "The first email from API",
"content": "This is the test messages",
"ccEmail": "cc@domain.com",
"bccEmail": "bcc@domain.com",
"replyEmail": "reply@domain.com",
"replyName": "Mr John",
"xMailer": "Microsoft Outlook",
"header1": "API Service from 5yMail.com",
"header2": "Source: Opensource",
"serverLocation": "usa",
"lang": "en"
}

Response - OK 

{
    "message": "OK",
    "error": null
}

 

POST with Postman

  

HTTP GET method

GET - https://service.5ymail.com/api

Format

https://service.5ymail.com/api?apiKey=<apiKey>&authUser=<authUser>&fromEmail=<fromEmail>&toEmail=<toEmail>&subject=<subject>&content=<content>&lang=<language>

Example

GET -  https://service.5ymail.com/api?apiKey=apiKey&authUser=chalovina&fromEmail=sender@5ymail.com&toEmail=han@google.com &subject=Test&content=TestEmail&lang=en

Response - OK 

{
    "message": "OK",
    "error": null
}

 

ERROR Response

There are defined errors as following. 

1. Missing required Paramters

{
    "message": "ERROR",
    "error": "Required request parameter 'apiKey' for method parameter type String is not present"
}

{
    "message": "ERROR",
    "error": "Required request parameter 'authUser' for method parameter type String is not present"
}

{
    "message": "ERROR",
    "error": "Required request parameter 'toEmail' for method parameter type String is not present"
}

{
    "message": "ERROR",
    "error": "Required request parameter 'content' for method parameter type String is not present"
}

{
    "message": "ERROR",
    "error": "Required request parameter 'subject' for method parameter type String is not present"
}

2. Api Key is invalid

{
    "message": "ERROR",
    "error": "apiKey invalid"
}

3. AuthUser or Lang is invalid

{
    "message": "ERROR",
    "error": "Username invalid or language associated to the account invalid."
}

4. User not yet activated

{
    "message": "ERROR",
    "error": "User not yet activated."
}

5. Normal Subscription expired

{
    "message": "ERROR",
    "error": "Your Normal Subscription expired."
}

6. API Subscription is not yet activated

{
    "message": "ERROR",
    "error": "Your API Subscription not yet activated."
}

7. API Subscription is expired

{
    "message": "ERROR",
    "error": "Your API Subscription expired."
}

8. API Subscription limited

{
    "message": "ERROR",
    "error": "Account reached to limit number of emails per day. You can upgrade to API Subscription to send more emails per day."
}

Our team has been trying our best to provide you the best services with different experiences. However, it's not easy to serve all of you and we would love to receive feedbacks from all of you to bring the better services.

Please don't hesitate to contact us for any information at Contact Us page.

Thank you so much!

The 5yMail team.