Summer.Batch.Extra.EmailSupport.EmailTasklet Class Reference

Tasklet for sending emails. The host, from, subject and body fields are mandatory. The body is read from a resource. At least one recipient should be specified (in to, cc, or bcc). More...

Inheritance diagram for Summer.Batch.Extra.EmailSupport.EmailTasklet:
Summer.Batch.Core.Step.Tasklet.ITasklet Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

RepeatStatus Execute (StepContribution contribution, ChunkContext chunkContext)
 Send the mail message given all needed information. More...
 
bool DoExecute ()
 Inner execute. More...
 
void AfterPropertiesSet ()
 

Properties

string Username [set]
 Smtp Username. More...
 
string Password [set]
 Smtp Password for above stmp username. More...
 
int Port [set]
 Port property. More...
 
string Host [set]
 Smtp Host. More...
 
string From [set]
 mail sender address. More...
 
string[] To [set]
 List of recipients property. More...
 
string[] Cc [set]
 list of cc recipients property. More...
 
string[] Bcc [set]
 list of Bcc recipients property. More...
 
string Subject [set]
 Mail subject More...
 
IResource Body [set]
 A resource containing the body of the e-mail. More...
 
int LineLength [set]
 The maximum line length of the e-mail. More...
 
Encoding Encoding [set]
 Encoding of the e-mail property. More...
 
Encoding InputEncoding [set]
 Input encoding of the e-mail property. More...
 

Detailed Description

Tasklet for sending emails. The host, from, subject and body fields are mandatory. The body is read from a resource. At least one recipient should be specified (in to, cc, or bcc).

Member Function Documentation

void Summer.Batch.Extra.EmailSupport.EmailTasklet.AfterPropertiesSet ( )

See also
IInitializationPostOperations::AfterPropertiesSet

Implements Summer.Batch.Common.Factory.IInitializationPostOperations.

bool Summer.Batch.Extra.EmailSupport.EmailTasklet.DoExecute ( )

Inner execute.

Returns
RepeatStatus Summer.Batch.Extra.EmailSupport.EmailTasklet.Execute ( StepContribution  contribution,
ChunkContext  chunkContext 
)

Send the mail message given all needed information.

See also
ITasklet::Execute
Parameters
contribution
chunkContext
Returns
Exceptions
Exception 

Implements Summer.Batch.Core.Step.Tasklet.ITasklet.

Property Documentation

string [] Summer.Batch.Extra.EmailSupport.EmailTasklet.Bcc
set

list of Bcc recipients property.

IResource Summer.Batch.Extra.EmailSupport.EmailTasklet.Body
set

A resource containing the body of the e-mail.

string [] Summer.Batch.Extra.EmailSupport.EmailTasklet.Cc
set

list of cc recipients property.

Encoding Summer.Batch.Extra.EmailSupport.EmailTasklet.Encoding
set

Encoding of the e-mail property.

string Summer.Batch.Extra.EmailSupport.EmailTasklet.From
set

mail sender address.

string Summer.Batch.Extra.EmailSupport.EmailTasklet.Host
set

Smtp Host.

Encoding Summer.Batch.Extra.EmailSupport.EmailTasklet.InputEncoding
set

Input encoding of the e-mail property.

int Summer.Batch.Extra.EmailSupport.EmailTasklet.LineLength
set

The maximum line length of the e-mail.

string Summer.Batch.Extra.EmailSupport.EmailTasklet.Password
set

Smtp Password for above stmp username.

int Summer.Batch.Extra.EmailSupport.EmailTasklet.Port
set

Port property.

string Summer.Batch.Extra.EmailSupport.EmailTasklet.Subject
set

Mail subject

string [] Summer.Batch.Extra.EmailSupport.EmailTasklet.To
set

List of recipients property.

string Summer.Batch.Extra.EmailSupport.EmailTasklet.Username
set

Smtp Username.


The documentation for this class was generated from the following file:
  • Summer.Batch.Extra/EmailSupport/EmailTasklet.cs