Bugfix: Return empty arrays rather than null for message To, CC, BCC, Inlines & Attachments

Bugfix: Return empty arrays rather than null for message To, CC, BCC, Inlines & Attachments

docs/apiv1/Message.md

@@ -26,8 +26,8 @@ Returns a JSON summary of the message and attachments.
       "Address": "jane@example.com"
     }
   ],
-  "Cc": null,
-  "Bcc": null,
+  "Cc": [],
+  "Bcc": [],
   "Subject": "Message subject",
   "Date": "2016-09-07T16:46:00+13:00",
   "Text": "Plain text MIME part of the email",
@@ -57,7 +57,7 @@ Returns a JSON summary of the message and attachments.
 
 - `Read` - always true (message marked read on open)
 - `From` - Name & Address, or null
-- `To`, `CC`, `BCC` - Array of Names & Address, or null
+- `To`, `CC`, `BCC` - Array of Names & Address
 - `Date` - Parsed email local date & time from headers
 - `Size` - Total size of raw email
 - `Inline`, `Attachments` - Array of attachments and inline images.

docs/apiv1/Messages.md

@@ -51,7 +51,7 @@ List messages in the mailbox. Messages are returned in the order of latest recei
           "Address": "accounts@example.com"
         }
       ],
-      "Bcc": null,
+      "Bcc": [],
       "Subject": "Message subject",
       "Created": "2022-10-03T21:35:32.228605299+13:00",
       "Size": 6144,
@@ -70,7 +70,7 @@ List messages in the mailbox. Messages are returned in the order of latest recei
 - `start` - The offset (default `0`) for pagination
 - `Read` - The read/unread status of the message
 - `From` - Name & Address, or null if none
-- `To`, `CC`, `BCC` - Array of Names & Address, or null if none
+- `To`, `CC`, `BCC` - Array of Names & Address
 - `Created` - Local date & time the message was received
 - `Size` - Total size of raw email in bytes
 

docs/apiv1/Search.md

@@ -47,7 +47,7 @@ Matching messages are returned in the order of latest received to oldest.
           "Address": "accounts@example.com"
         }
       ],
-      "Bcc": null,
+      "Bcc": [],
       "Subject": "Test email",
       "Created": "2022-10-03T21:35:32.228605299+13:00",
       "Size": 6144,
@@ -65,5 +65,5 @@ Matching messages are returned in the order of latest received to oldest.
 - `count` - Number of messages returned in request
 - `start` - The offset (default `0`) for pagination
 - `From` - Singular Name & Address, or null if none
-- `To`, `CC`, `BCC` - Array of Name & Address, or null if none
+- `To`, `CC`, `BCC` - Array of Name & Address
 - `Size` - Total size of raw email in bytes

server/ui-src/templates/Message.vue

@@ -128,29 +128,27 @@ export default {
 						<tr class="small">
 							<th>To</th>
 							<td class="privacy">
-								<span v-if="message.To" v-for="(t, i) in message.To">
+								<span v-if="message.To && message.To.length" v-for="(t, i) in message.To">
 									<template v-if="i > 0">, </template>
-									<span class="text-nowrap">{{ t.Name + " <" + t.Address +">" }}</span>
+									<span class="text-nowrap">{{ t.Name + " <" + t.Address + ">" }}</span>
 									</span>
 									<span v-else>Undisclosed recipients</span>
 							</td>
 						</tr>
-						<tr v-if="message.Cc" class="small">
+						<tr v-if="message.Cc && message.Cc.length" class="small">
 							<th>CC</th>
 							<td class="privacy">
 								<span v-for="(t, i) in message.Cc">
 									<template v-if="i > 0">,</template>
-									{{ t.Name + " <" + t.Address +">" }}
-								</span>
+									{{ t.Name + " <" + t.Address + ">" }} </span>
 							</td>
 						</tr>
-						<tr v-if="message.Bcc" class="small">
-							<th>CC</th>
+						<tr v-if="message.Bcc && message.Bcc.length" class="small">
+							<th>BCC</th>
 							<td class="privacy">
 								<span v-for="(t, i) in message.Bcc">
 									<template v-if="i > 0">,</template>
-									{{ t.Name + " <" + t.Address +">" }}
-								</span>
+									{{ t.Name + " <" + t.Address + ">" }} </span>
 							</td>
 						</tr>
 						<tr>
@@ -174,7 +172,7 @@ export default {
 					</button>
 					<ul class="dropdown-menu">
 						<li v-for="part in allAttachments(message)">
-							<a :href="'api/v1/message/'+message.ID+'/part/'+part.PartID" type="button"
+							<a :href="'api/v1/message/' + message.ID + '/part/' + part.PartID" type="button"
 								class="dropdown-item" target="_blank">
 								<i class="bi" :class="attachmentIcon(part)"></i>
 								{{ part.FileName != '' ? part.FileName : '[ unknown ]' }}
@@ -195,7 +193,7 @@ export default {
 					v-if="message.HTML">HTML Source</button>
 				<button class="nav-link" id="nav-plain-text-tab" data-bs-toggle="tab" data-bs-target="#nav-plain-text"
 					type="button" role="tab" aria-controls="nav-plain-text" aria-selected="false"
-					:class="message.HTML == '' ? 'show':''">Text</button>
+					:class="message.HTML == '' ? 'show' : ''">Text</button>
 				<button class="nav-link" id="nav-raw-tab" data-bs-toggle="tab" data-bs-target="#nav-raw" type="button"
 					role="tab" aria-controls="nav-raw" aria-selected="false">Raw</button>
 			</div>
@@ -214,7 +212,7 @@ export default {
 				<pre><code class="language-html">{{ message.HTML }}</code></pre>
 			</div>
 			<div class="tab-pane fade" id="nav-plain-text" role="tabpanel" aria-labelledby="nav-plain-text-tab"
-				tabindex="0" :class="message.HTML == '' ? 'show':''">
+				tabindex="0" :class="message.HTML == '' ? 'show' : ''">
 				<div class="text-view">{{ message.Text }}</div>
 				<Attachments v-if="allAttachments(message).length" :message="message"
 					:attachments="allAttachments(message)"></Attachments>

storage/database.go

@@ -386,6 +386,8 @@ func GetMessage(id string) (*Message, error) {
 	var re = regexp.MustCompile(`(?U)<base .*>`)
 	html := re.ReplaceAllString(env.HTML, "")
 	obj.HTML = html
+	obj.Inline = []Attachment{}
+	obj.Attachments = []Attachment{}
 
 	for _, i := range env.Inlines {
 		if i.FileName != "" || i.ContentID != "" {

storage/utils.go

@@ -19,7 +19,10 @@ import (
 
 // Return a header field as a []*mail.Address, or "null" is not found/empty
 func addressToSlice(env *enmime.Envelope, key string) []*mail.Address {
-	data, _ := env.AddressList(key)
+	data, err := env.AddressList(key)
+	if err != nil {
+		return []*mail.Address{}
+	}
 
 	return data
 }