GetMailList(MailType.Rank)

public BackndMailReturnObject GetMailList(MailType.Rank);
public BackndMailReturnObject GetMailList(MailType.Rank, int limit);

BackndMailReturnObject

GetReturnValueByMailItemList(MailType mailType)

If an error occurred, null is returned.

BackndMailReturnObject bro = Backnd.Mail.GetMailList(MailType.Rank, 10);

foreach(BackndMailItem item in bro.GetReturnValueByMailItemList(MailType.Rank)) {
    Debug.Log(item.ToString());
}

BackndMailItem

public class BackndMailItem
{
    public MailType postType;
    public string title = string.Empty;
    public string content = string.Empty;
    public string expirationDate = string.Empty;
    public string reservationDate = string.Empty;
    public string sentDate = string.Empty;
    public string nickname = string.Empty;
    public string inDate = string.Empty;
    public string author = string.Empty;
    public string rankType = string.Empty;
    public List<BackndMailContentItem> items = new List<BackndMailContentItem>();
}

public class BackndMailContentItem
{
    public string chartFileName = string.Empty;
    public string chartName = string.Empty;
    public Dictionary<string, string> itemInfo = new Dictionary<string, string>();
    public string itemCount = string.Empty;
}

Parameters

Value	Type	Description
mailType	MailType	Type of mail to load
limit	int	Number of mail to load. Choose between 10 and 100. The limit is set to 10 by default.

'limit' evaluates to 10 if you specify a smaller number.

MailType

Value	Description
Admin	Admin mail sent from BACKND Console
Rank	Ranking mail sent automatically after ranking settlement
Coupon	Coupon mail sent after using a coupon with the page created in Web Coupon Settings in BACKND Console
User	User mail sent using each user's data

Description

Loads the mail list of the given type(MailType).

The return value varies for each MailType, so please refer to GetReturnValuetoJSON() below.
Note that user mail has vastly different JSON type from admin or ranking mail.

• The data types "S", "L", and "M" in the return values of the previous mail function(Backnd.Player.Post) was removed.
• Every mail has an expiration date according to its type, after which the mail gets deleted from the list.
• The user who loaded the mail is marked as 'Unclaimed' on the Mail Management page of the console. When claimed, the date is overwritten.
• Items that are attached to ranking mail are automatically removed after the user claims them.
• The mail expires seven days after it is sent.

Ranking mail title

• For more information on rules to create ranking mail titles, please refer to the documentation on checking ranking rewards.

Guild ranking mail rewards

• If a user leaves a guild without checking the guild ranking rewards mail, they cannot receive the guild ranking rewards from the guild they left and cannot check the mail even after rejoining. Users can receive guild ranking rewards mail by calling GetMailList() only if they are a member of the guild.(not the case for users who join after the reward handout)

Example

Synchronous

BackndMailReturnObject bro = Backnd.Mail.GetMailList(MailType.Rank, 10);

foreach(BackndMailItem item in bro.GetReturnValueByMailItemList(MailType.Rank)) {
    Debug.Log(item.ToString());
    Debug.Log("Title : " item.title);
    Debug.Log("itemInfo : " + item.items[0].Keys);
}

Asynchronous

Backnd.Mail.GetMailList(MailType.Rank, 10, callback => {
   BACKND.LitJson.JsonData json = callback.GetReturnValuetoJSON()["postList"];

   for(int i = 0; i < json.Count; i++)  {
      Debug.Log("Title : " + json[i]["title"].ToString());
      Debug.Log("inDate : " +  json[i]["inDate"].ToString());
   }
});

Return cases

Success cases

When mail is loaded successfully
statusCode : 200

returnValue : refer to GetReturnValuetoJSON

When there is no mail to load
statusCode : 200

returnValue : { "postList" : []}

GetReturnValuetoJSON

Ranking Mail

Ranking mail always has only one item. It is, however, inside an array type, similar to that of admin mail.

{
    "postList": [
        {
            "rankType": "user", // Ranking type("guild" or "user")
            "content":"Max score rank(1–1)", // Content of ranking reward
            "expirationDate": "2021-12-26T19:03:52.243Z", // Expiration date
            "reservationDate": "2021-12-19T19:03:52.243Z", // Mail registration date
            "nickname": "User2", // Receiving user
            "inDate": "2021-12-19T19:03:52.243Z", // Mail's inDate
            "title":"Max score rank(1–1)", // Title of the ranking rewards mail
            "sentDate": "2021-12-19T19:03:52.243Z", // Sent date
            "items": [
                {
                    "item": {
                        "itemID": "i104",
                        "itemName": "Item4",
                    },
                    "itemCount": 999999,
                    "chartName": "Ranking rewards chart"
                }
            ]
        },
        {
            "rankType": "guild",
            "content": "All Random All Mid ranking(21–40)",
            "expirationDate": "2021-12-26T19:03:44.163Z",
            "reservationDate": "2021-12-19T19:03:44.163Z",
            "nickname": "User2",
            "inDate": "2021-12-19T19:03:44.163Z",
            "title": "All Random All Mid ranking(21–40)",
            "sentDate": "2021-12-19T19:03:44.163Z",
            "items": [
                {
                    "item": {
                        "itemID": "i102",
                        "itemName": "Item2",
                        "hpPower": "10",
                        "aabab": "2"
                    },
                    "itemCount": 1,
                    "chartName": "Ranking rewards chart2"
                }
            ]
        }
    ]
}

Sample code

This example works for admin, ranking, and coupon mail.

public class MailDataTableItem {
    public string chartFileName;
    public string itemID;
    public string itemName;
    public string hpPower;
    public int itemCount;
    public override string ToString() {
        return
        "item : \n" +
        $"| chartFileName : {chartFileName}\n" +
        $"| itemID : {itemID}\n" +
        $"| itemName : {itemName}\n" +
        $"| itemCount : {itemCount}\n" +
        $"| hpPower : {hpPower}\n";
    }
}
public class MailItem {
    public MailType mailType;
    public string title;
    public string content;
    public DateTime expirationDate;
    public DateTime reservationDate;
    public DateTime sentDate;
    public string nickname;
    public string inDate;
    public string author; // Exists only in admin mail
    public string rankType; // Exists only in ranking mail
    public List<MailDataTableItem> items = new List<MailDataTableItem>();
    public override string ToString() {
        string totalString =
        $"title : {title}\n" +
        $"inDate : {inDate}\n";
        if(mailType == MailType.Admin || mailType == MailType.Rank) {
            totalString +=
            $"content : {content}\n" +
            $"expirationDate : {expirationDate}\n" +
            $"reservationDate : {reservationDate}\n" +
            $"sentDate : {sentDate}\n" +
            $"nickname : {nickname}\n";
            if(mailType == MailType.Admin) {
                totalString += $"author : {author}\n";
            }
            if(mailType == MailType.Rank) {
                totalString += $"rankType : {rankType}\n";
            }
        }
        string itemList = string.Empty;
        for(int i = 0; i < items.Count; i++) {
            itemList += items[i].ToString();
            itemList += "\n";
        }
        totalString += itemList;
        return totalString;
    }
}

public void GetMailListTest() {
    int limit = 100;
    MailType mailType = MailType.Rank;
    BackndMailReturnObject bro = Backnd.Mail.GetMailList(mailType, limit);
    if(!bro.IsSuccess()) {
        Debug.LogError(bro.ToString());
        return;
    }
    BACKND.LitJson.JsonData postListJson = bro.GetReturnValuetoJSON()["postList"];

    List<MailItem> postItemList = new List<MailItem>();

    for(int i = 0; i < postListJson.Count; i++) {

        MailItem postItem = new MailItem();

        postItem.inDate = postListJson[i]["inDate"].ToString();
        postItem.title = postListJson[i]["title"].ToString();
        postItem.mailType = mailType;

        if(mailType == MailType.Admin || mailType == MailType.Rank) {
            postItem.content = postListJson[i]["content"].ToString();
            postItem.expirationDate = DateTime.Parse(postListJson[i]["expirationDate"].ToString());
            postItem.reservationDate = DateTime.Parse(postListJson[i]["reservationDate"].ToString());
            postItem.nickname = postListJson[i]["nickname"]?.ToString();
            postItem.sentDate = DateTime.Parse(postListJson[i]["sentDate"].ToString());

            if(postListJson[i].ContainsKey("author")) {
                postItem.author = postListJson[i]["author"].ToString();
            }
            if(postListJson[i].ContainsKey("rankType")) {
                postItem.author = postListJson[i]["rankType"].ToString();
            }
        }
        if(postListJson[i]["items"].Count > 0) {

            for(int itemNum = 0; itemNum < postListJson[i]["items"].Count; itemNum++) {

                MailDataTableItem item = new MailDataTableItem();
                item.itemCount = int.Parse(postListJson[i]["items"][itemNum]["itemCount"].ToString());
                item.chartFileName = postListJson[i]["items"][itemNum]["item"]["chartFileName"].ToString();
                item.itemID = postListJson[i]["items"][itemNum]["item"]["itemID"].ToString();
                item.itemName = postListJson[i]["items"][itemNum]["item"]["itemName"].ToString();
                item.hpPower = postListJson[i]["items"][itemNum]["item"]["hpPower"].ToString();

                postItem.items.Add(item);
            }
        }

        postItemList.Add(postItem);
        Debug.Log(postItem.ToString());
    }
}