1 /*global $k*/
  2 
  3 /**
  4  * @class
  5  * @extends $k.NetEntity
  6 **/
  7 $k.MailMessage = function() { };
  8 
  9 /**
 10  * Get the blind carbon copy receivers ('bcc' field)
 11  *
 12  * @function
 13  * @returns {string[]}
 14 **/
 15 $k.MailMessage.prototype.bcc = function() { };
 16 
 17 /**
 18  * Get the  carbon copy receivers ('cc' field)
 19  *
 20  * @function
 21  * @returns {string[]}
 22 **/
 23 $k.MailMessage.prototype.cc = function() { };
 24 
 25 /**
 26  * Get the charset of the headers
 27  *
 28  * @function
 29 **/
 30 $k.MailMessage.prototype.headerCharset = function() { };
 31 
 32 /**
 33  * Get the receiver ('to' field)
 34  *
 35  * @function
 36  * @returns {string[]}
 37 **/
 38 $k.MailMessage.prototype.receiver = function() { };
 39 
 40 /**
 41  * Send the mail, using the SMTP configuration of the volume
 42  *
 43  * @function
 44  * @param {boolean} [async] True if the mail should be sent asynchronously, false if send() should block until the mail has been sent. Default is true.
 45 **/
 46 $k.MailMessage.prototype.send = function(async) { };
 47 
 48 /**
 49  * Get the sender
 50  *
 51  * @function
 52  * @returns {string[]}
 53 **/
 54 $k.MailMessage.prototype.sender = function() { };
 55 
 56 /**
 57  * Set the blind carbon copy receivers ('bcc' field)
 58  *
 59  * @function
 60  * @param receivers String or Array of strings
 61 **/
 62 $k.MailMessage.prototype.setBcc = function(receivers) { };
 63 
 64 /**
 65  * Set the  carbon copy receivers ('cc' field)
 66  *
 67  * @function
 68  * @param receivers String or Array of strings
 69 **/
 70 $k.MailMessage.prototype.setCc = function(receivers) { };
 71 
 72 /**
 73  * Set the charset of the headers
 74  *
 75  * @function
 76  * @param {string} charset Charset (encoding) of the headers
 77  * @throws {$k.exception.InvalidValue} If the charset is unknown
 78 **/
 79 $k.MailMessage.prototype.setHeaderCharset = function(charset) { };
 80 
 81 /**
 82  * Set the receiver ('to' field)
 83  *
 84  * @function
 85  * @param receivers String or Array of strings
 86  * @throws {$k.exception.InvalidValue} If the value is not a valid receiver
 87 **/
 88 $k.MailMessage.prototype.setReceiver = function(receivers) { };
 89 
 90 /**
 91  * Set the sender ('from' field)
 92  *
 93  * @function
 94  * @param {string} sender
 95  * @throws {$k.exception.InvalidValue} If the value is not a valid sender
 96 **/
 97 $k.MailMessage.prototype.setSender = function(sender) { };
 98 
 99 /**
100  * Set the subject
101  *
102  * @function
103  * @param {string} subject
104  * @throws {$k.exception.InvalidValue} If the value is not a valid subject
105 **/
106 $k.MailMessage.prototype.setSubject = function(subject) { };
107 
108 /**
109  * Set the name of the user account. Required if the SMTP configuration requires authentication and more than one user is configured
110  *
111  * @function
112  * @param {string} username
113 **/
114 $k.MailMessage.prototype.setUserName = function(username) { };
115 
116 /**
117  * Get the subject
118  *
119  * @function
120  * @returns {string}
121 **/
122 $k.MailMessage.prototype.subject = function() { };
123 
124 /**
125  * Get the name of the user account
126  *
127  * @function
128  * @returns {string}
129 **/
130 $k.MailMessage.prototype.userName = function() { };
131 
132