ReisuDesign: Created page with "{{Documentation/Header}} This template displays Mails. Uses {{T|Phantom Mail}}. ==Syntax== {{T|Mail |v1=title = mail's title |v2=sender = mail's sender |v3=date = earliest date on which the mail could be obtained in-game |v4=text = mail's text |v5=items = comma-separated list of the items attached to the mail |v6=type = mail's type, e.g. Birthday/Event/Pre-Registration |v7=neighbor = if the mail's type is "Birthday", whose birthday it is..."

2026-09-12T14:35:28Z

Created page with "{{Documentation/Header}} This template displays Mails. Uses {{T|Phantom Mail}}. ==Syntax== {{T|Mail |v1=title = mail's title |v2=sender = mail's sender |v3=date = earliest date on which the mail could be obtained in-game |v4=text = mail's text |v5=items = comma-separated list of the items attached to the mail |v6=type = mail's type, e.g. Birthday/Event/Pre-Registration |v7=neighbor = if the mail's type is "Birthday", whose birthday it is..."

New page

{{Documentation/Header}}
This template displays [[Mail]]s.

Uses {{T|Phantom Mail}}.

==Syntax==
{{T|Mail
|v1=title = mail's title
|v2=sender = mail's sender
|v3=date = earliest date on which the mail could be obtained in-game
|v4=text = mail's text
|v5=items = comma-separated list of the items attached to the mail
|v6=type = mail's type, e.g. Birthday/Event/Pre-Registration
|v7=neighbor = if the mail's type is "Birthday", whose birthday it is for
|v8=mention = comma-separated list of the neighbors mentioned in the mail
|v9=event = if the mail's type is "Event", add the name of the event here
|block=1}}
* {{F|date}} — For birthdays, the date will always be a neighbor's known birth date, regardless of when it was obtained in-game

==Examples==
{{T|Mail
|p1=title = Mail Title
|p2=sender = Esassani
|p3=date = 2026-09-20
|p4=text = Some text going here
|p5=items = Rice*1;Melon*1
|p6=type = Birthday
|p7=neighbor = Esassani
|p8=mention = Dorjelang
|block=1|_Y_=1}}

==Template Data==
<templatedata>
{
"params": {
"title": {
"example": "Just the Two of Us!",
"type": "string",
"description": "Uses the mail's title.",
"required": true,
"label": "Title"
},
"sender": {
"type": "string",
"default": "P・A・I・M・O・N",
"label": "Sender",
"description": "Sender of the mail."
},
"date": {
"example": "2020-10-09 00:00",
"type": "date",
"description": "Please format it this way:\nYYYY-MM-DD HH:mm\n(24h format)",
"required": true,
"label": "Date"
},
"text": {
"type": "string",
"description": "Contains the body of the mail.",
"suggested": true,
"label": "Text"
},
"items": {
"example": "Delicious Butter Crab*1",
"type": "string",
"description": "Displays the items that are attached to the mail in {{Card List}}",
"label": "Attachments",
"suggested": true,
"default": "\"None\""
},
"item_type": {
"label": "Item Type",
"description": "Type of item given in mail.",
"example": "Item,neighbor",
"type": "string"
},
"item_delim": {
"label": "Item Delimiter",
"description": "neighbor(s) to split input items by.",
"example": ";",
"type": "string",
"default": ","
},
"type": {
"example": "Birthday",
"type": "string",
"description": "Defines the type of the mail.",
"suggested": true,
"label": "Type"
},
"neighbor": {
"label": "Birthday neighbor",
"description": "If the mail's type is \"Birthday\", include with the neighbor's name whose birthday it is",
"type": "string"
},
"mention": {
"type": "string",
"description": "Allows to gather mentions to display in other templates.",
"label": "neighbor Mentions",
"suggested": true
},
"note": {
"description": "Optional, and should not be used often. This should be used with the note_type parameter.",
"type": "string"
},
"note_type": {
"description": "Optional, and should not be used often. This should be used with the note parameter. This is the type of the note, or the location of it. Possible values: title, sender, date, text, items",
"type": "string"
},
"event": {
"label": "Event Name",
"description": "If the mail's type is \"Event\", add the name of the event here",
"type": "string"
}
},
"format": "{{_\n|_________ = _\n}}",
"description": "Displays mails in a table.",
"paramOrder": [
"title",
"sender",
"date",
"text",
"items",
"item_type",
"item_delim",
"type",
"neighbor",
"mention",
"note",
"note_type",
"event"
]
}
</templatedata>

Template:Mail/doc - Revision history