WoW:API GetInboxHeaderInfo - Revision history

Move page script: Move page script moved page API GetInboxHeaderInfo to WoW:API GetInboxHeaderInfo without leaving a redirect

2023-08-15T04:45:59Z

Move page script moved page API GetInboxHeaderInfo to API GetInboxHeaderInfo without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Artaxiel: /* Returns */ two hours it took me to figure that out, two smegging hours. Anyone know a better way?

2008-02-09T04:12:49Z

Returns: two hours it took me to figure that out, two smegging hours. Anyone know a better way?

← Older revision		Revision as of 04:12, 9 February 2008
Line 15:		Line 15:
	:;CODAmount : Number - The amount of COD payment required to receive the package		:;CODAmount : Number - The amount of COD payment required to receive the package
	:;daysLeft : Number - The number of days (fractional) before the message expires		:;daysLeft : Number - The number of days (fractional) before the message expires
	:;hasItem : Number - Either the number of attachments or nil if no items are present		:;hasItem : Number - Either the number of attachments or nil if no items are present. Note that items that have been taken from the mailbox continue to occupy empty slots, but hasItem is the total number of items remaining in the mailbox. Use ATTACHMENTS_MAX_RECEIVE for the total number of attachments rather than this.
	:;wasRead : Flag - 1 if the mail has been read, nil otherwise. Using [[API GetInboxText\|GetInboxText]]() marks an item as read.		:;wasRead : Flag - 1 if the mail has been read, nil otherwise. Using [[API GetInboxText\|GetInboxText]]() marks an item as read.
	:;wasReturned : Flag - 1 if the mail was returned, nil otherwise		:;wasReturned : Flag - 1 if the mail was returned, nil otherwise

WoWWiki>Lordship: 2.3 change, different behaviour of hasItem

2007-12-29T16:36:12Z

2.3 change, different behaviour of hasItem

← Older revision		Revision as of 16:36, 29 December 2007
Line 15:		Line 15:
	:;CODAmount : Number - The amount of COD payment required to receive the package		:;CODAmount : Number - The amount of COD payment required to receive the package
	:;daysLeft : Number - The number of days (fractional) before the message expires		:;daysLeft : Number - The number of days (fractional) before the message expires
	:;hasItem : ~~Flag~~ - ~~1 if~~ the ~~mail still has an item in it,~~ nil ~~otherwise~~		:;hasItem : Number - Either the number of attachments or nil if no items are present
	:;wasRead : Flag - 1 if the mail has been read, nil otherwise. Using [[API GetInboxText\|GetInboxText]]() marks an item as read.		:;wasRead : Flag - 1 if the mail has been read, nil otherwise. Using [[API GetInboxText\|GetInboxText]]() marks an item as read.
	:;wasReturned : Flag - 1 if the mail was returned, nil otherwise		:;wasReturned : Flag - 1 if the mail was returned, nil otherwise

WoWWiki>Garuk: /* Notes */

2007-11-03T05:39:33Z

Notes

← Older revision		Revision as of 05:39, 3 November 2007
Line 29:		Line 29:
	==Notes==		==Notes==
	This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox\|CheckInbox()]] was called.		This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox\|CheckInbox()]] was called.

			Details of an Auction House message can be extracted with [[API_GetInboxInvoiceInfo\|GetInboxInvoiceInfo()]].

WoWWiki>Baudzilla: Added note that GetInboxText marks an item as read

2007-07-13T23:49:07Z

Added note that GetInboxText marks an item as read

← Older revision		Revision as of 23:49, 13 July 2007
Line 16:		Line 16:
	:;daysLeft : Number - The number of days (fractional) before the message expires		:;daysLeft : Number - The number of days (fractional) before the message expires
	:;hasItem : Flag - 1 if the mail still has an item in it, nil otherwise		:;hasItem : Flag - 1 if the mail still has an item in it, nil otherwise
	:;wasRead : Flag - 1 if the mail has been read, nil otherwise		:;wasRead : Flag - 1 if the mail has been read, nil otherwise. Using [[API GetInboxText\|GetInboxText]]() marks an item as read.
	:;wasReturned : Flag - 1 if the mail was returned, nil otherwise		:;wasReturned : Flag - 1 if the mail was returned, nil otherwise
	:;textCreated : Flag - 1 if a letter object has been created from this mail, nil otherwise		:;textCreated : Flag - 1 if a letter object has been created from this mail, nil otherwise

WoWWiki>Sarf: added isGM value, fixed a minor line break issue with long snippet

2007-01-27T07:14:30Z

added isGM value, fixed a minor line break issue with long snippet

← Older revision		Revision as of 07:14, 27 January 2007
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns information about an item in the mailbox.		Returns information about an item in the mailbox.
	packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);		packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned,
			textCreated, canReply, isGM = GetInboxHeaderInfo(index);

	==Parameters==		==Parameters==
Line 19:		Line 20:
	:;textCreated : Flag - 1 if a letter object has been created from this mail, nil otherwise		:;textCreated : Flag - 1 if a letter object has been created from this mail, nil otherwise
	:;canReply : Flag - 1 if this letter can be replied to, nil otherwise		:;canReply : Flag - 1 if this letter can be replied to, nil otherwise
			:;isGM : Flag - 1 if this letter was sent by a GameMaster

	==Example==		==Example==

WoWWiki>Starlightblunder: {{wowapi}}, format

2006-12-23T23:05:42Z

{{wowapi}}, format

← Older revision		Revision as of 23:05, 23 December 2006
Line 1:		Line 1:
	~~<center>'''~~GetInboxHeaderInfo(index)~~''' ''-Documentation by [[user:BaHaMuTNeO]], [[user:Flickering\|Flickering]] -''</center>~~		{{wowapi}} __NOTOC__
			Returns information about an item in the mailbox.
			packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);

	~~packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply~~ = ~~GetInboxHeaderInfo(index);~~		==Parameters==
			===Arguments===
	~~Returns information about a mailbox item.~~

	~~----~~
	~~;''~~Arguments''

	~~:(index)~~
	:;index : Number - the index of the message (1 is the first message)		:;index : Number - the index of the message (1 is the first message)
			===Returns===
	~~----~~
	~~;''~~Returns''


	~~packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply~~
	:;packageIcon : String - texture path for package icon if it contains a package (nil otherwise)		:;packageIcon : String - texture path for package icon if it contains a package (nil otherwise)
	:;stationeryIcon : String - texture path for mail message icon.		:;stationeryIcon : String - texture path for mail message icon.
Line 29:		Line 20:
	:;canReply : Flag - 1 if this letter can be replied to, nil otherwise		:;canReply : Flag - 1 if this letter can be replied to, nil otherwise

	~~----~~		==Example==
	~~;''~~Example''

	~~<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->~~
	local packageTexture = GetInboxHeaderInfo(1);		local packageTexture = GetInboxHeaderInfo(1);
			===Result===
	~~;''~~Result''

	packageTexture is "Interface\Icons\INV_Scroll_03.blp"		packageTexture is "Interface\Icons\INV_Scroll_03.blp"

	~~----~~		==Notes==
	~~;''Details''~~

	This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox\|CheckInbox()]] was called.		This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox\|CheckInbox()]] was called.

	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>Anticrash at 14:49, 4 January 2006

2006-01-04T14:49:31Z

← Older revision		Revision as of 14:49, 4 January 2006
Line 46:		Line 46:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|GetInboxHeaderInfo]]~~
	~~[[Category:API Mail Functions\|GetInboxHeaderInfo]]~~

WoWWiki>Feysharnalie at 06:14, 4 January 2006

2006-01-04T06:14:08Z

← Older revision		Revision as of 06:14, 4 January 2006
Line 42:		Line 42:
	;''Details''		;''Details''

	This function may be called from anywhere in the world, but will only be current as of the last time CheckInbox() was called.		This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox\|CheckInbox()]] was called.

	----		----

WoWWiki>WoWWiki-Grayswandir at 06:19, 12 September 2005

2005-09-12T06:19:29Z

← Older revision		Revision as of 06:19, 12 September 2005
Line 42:		Line 42:
	;''Details''		;''Details''

	~~You must~~ be ~~by near to mailbox~~, ~~and have opened it for this to operate~~.		This function may be called from anywhere in the world, but will only be current as of the last time CheckInbox() was called.

	----		----