messageBuilder Class Reference
A helper for building MIME messages. More...
Detailed Description
A helper for building MIME messages.
Constructor & Destructor Documentation
| messageBuilder | ( | ) |
| ~messageBuilder | ( | ) |
Member Function Documentation
| void appendAttachment | ( | ref< attachment > | attach | ) |
Attach a new object to the message.
- Parameters:
-
attach new attachment
| void attach | ( | ref< attachment > | attach | ) |
Attach a new object to the message.
- Deprecated:
- Use messageBuilder::appendAttachment() instead.
- Parameters:
-
attach new attachment
| ref< message > construct | ( | ) | const |
Construct a new message based on the information specified in this object.
- Returns:
- a new message
| void constructTextPart | ( | const mediaType & | type | ) |
Change the type of the text part and construct a new part.
- Parameters:
-
type media type of the text part
Referenced by messageBuilder::~messageBuilder().
| ref< attachment > getAttachmentAt | ( | const int | pos | ) |
Return the attachment at the specified position.
- Parameters:
-
pos position of the attachment
- Returns:
- attachment at the specified position
| const ref< const attachment > getAttachmentAt | ( | const int | pos | ) | const |
Return the attachment at the specified position.
- Parameters:
-
pos position of the attachment
- Returns:
- attachment at the specified position
| int getAttachmentCount | ( | ) | const |
Return the number of attachments in the message.
- Returns:
- number of attachments
| const std::vector< ref< attachment > > getAttachmentList | ( | ) |
Return the list of attachments.
- Returns:
- list of attachments
| const std::vector< ref< const attachment > > getAttachmentList | ( | ) | const |
Return the list of attachments.
- Returns:
- list of attachments
| addressList & getBlindCopyRecipients | ( | ) |
Return the blind-copy recipients of the message (Bcc:).
- Returns:
- blind-copy recipients of the message
| const addressList & getBlindCopyRecipients | ( | ) | const |
Return the blind-copy recipients of the message (Bcc:).
- Returns:
- blind-copy recipients of the message
| addressList & getCopyRecipients | ( | ) |
Return the copy recipients of the message (Cc:).
- Returns:
- copy recipients of the message
| const addressList & getCopyRecipients | ( | ) | const |
Return the copy recipients of the message (Cc:).
- Returns:
- copy recipients of the message
| const mailbox & getExpeditor | ( | ) | const |
Return the expeditor of the message (From:).
- Returns:
- expeditor of the message
| addressList & getRecipients | ( | ) |
Return the recipients of the message (To:).
return recipients of the message
| const addressList & getRecipients | ( | ) | const |
Return the recipients of the message (To:).
return recipients of the message
| const text & getSubject | ( | ) | const |
Return the subject of the message.
- Returns:
- subject of the message
| ref< textPart > getTextPart | ( | ) |
Return the text part of the message.
- Returns:
- text part of the message
| void removeAttachment | ( | const int | pos | ) |
Remove the attachment at the specified position.
- Parameters:
-
pos position of the attachment to remove
| void setBlindCopyRecipients | ( | const addressList & | bcc | ) |
Set the blind-copy recipients of the message (Bcc:).
- Parameters:
-
bcc list of blind-copy recipients
| void setCopyRecipients | ( | const addressList & | cc | ) |
Set the copy recipients of the message (Cc:).
- Parameters:
-
cc list of copy recipients
| void setExpeditor | ( | const mailbox & | expeditor | ) |
Set the expeditor of the message (From:).
- Parameters:
-
expeditor expeditor of the message
| void setRecipients | ( | const addressList & | recipients | ) |
Set the recipients of the message (To:).
- Parameters:
-
recipients list of recipients
| void setSubject | ( | const text & | subject | ) |
Set the subject of the message.
- Parameters:
-
subject message subject
The documentation for this class was generated from the following files:
