Built by Maven

changes:announcement-mail

Full name:

org.apache.maven.plugins:maven-changes-plugin:3.0.0-M3:announcement-mail

Description:

Goal which sends an announcement through email.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0-beta-2.
  • Invokes the execution of the following plugin's goal prior to executing itself: announcement-generate.

Required Parameters

Name Type Since Description
<announcementDirectory> File 2.10 Directory where the generated announcement file exists.
Default: ${project.build.directory}/announcement
<announcementFile> String 2.10 The file that contains the generated announcement.
Default: announcement.vm
User Property: changes.announcementFile
<basedir> String 2.1 The current project base directory.
User Property: basedir
<mailContentType> String 2.1 Mail content type to use.
Default: text/plain
<smtpHost> String - Smtp Server.
User Property: changes.smtpHost
<smtpPort> int - Port.
Default: 25
User Property: changes.smtpPort
<subject> String - Subject for the email.
Default: [ANNOUNCEMENT] - ${project.name} ${project.version} released
User Property: changes.subject
<toAddresses> List<Object> - Recipient email address.

Optional Parameters

Name Type Since Description
<bccAddresses> List<Object> 2.5 Recipient bcc email address.
<ccAddresses> List<Object> 2.5 Recipient cc email address.
<fromDeveloperId> String - The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
User Property: changes.fromDeveloperId
<mailSender> MailSender - Defines the sender of the announcement email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.
User Property: changes.mailSender
<password> String - The password used to send the email.
User Property: changes.password
<runOnlyAtExecutionRoot> boolean 2.3 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default: false
User Property: announcement.runOnlyAtExecutionRoot
<senderString> String 2.7 Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM.

This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
User Property: changes.sender
<sslMode> boolean - If the email should be sent in SSL mode.
Default: false
User Property: changes.sslMode
<startTls> boolean 2.10 If the option startTls should be used.
Default: false
User Property: changes.startTls
<templateEncoding> String 2.10 The encoding used in the announcement template.
Default: ${project.build.sourceEncoding}
User Property: changes.templateEncoding
<username> String - The username used to send the email.
User Property: changes.username

Parameter Details

<announcementDirectory>

Directory where the generated announcement file exists.
  • Type: java.io.File
  • Since: 2.10
  • Required: Yes
  • Default: ${project.build.directory}/announcement

<announcementFile>

The file that contains the generated announcement.
  • Type: java.lang.String
  • Since: 2.10
  • Required: Yes
  • User Property: changes.announcementFile
  • Default: announcement.vm

<basedir>

The current project base directory.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • User Property: basedir

<bccAddresses>

Recipient bcc email address.
  • Type: java.util.List<java.lang.Object>
  • Since: 2.5
  • Required: No

<ccAddresses>

Recipient cc email address.
  • Type: java.util.List<java.lang.Object>
  • Since: 2.5
  • Required: No

<fromDeveloperId>

The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
  • Type: java.lang.String
  • Required: No
  • User Property: changes.fromDeveloperId

<mailContentType>

Mail content type to use.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • Default: text/plain

<mailSender>

Defines the sender of the announcement email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.

<password>

The password used to send the email.
  • Type: java.lang.String
  • Required: No
  • User Property: changes.password

<runOnlyAtExecutionRoot>

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: announcement.runOnlyAtExecutionRoot
  • Default: false

<senderString>

Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM.

This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
  • Type: java.lang.String
  • Since: 2.7
  • Required: No
  • User Property: changes.sender

<smtpHost>

Smtp Server.
  • Type: java.lang.String
  • Required: Yes
  • User Property: changes.smtpHost

<smtpPort>

Port.
  • Type: int
  • Required: Yes
  • User Property: changes.smtpPort
  • Default: 25

<sslMode>

If the email should be sent in SSL mode.
  • Type: boolean
  • Required: No
  • User Property: changes.sslMode
  • Default: false

<startTls>

If the option startTls should be used.
  • Type: boolean
  • Since: 2.10
  • Required: No
  • User Property: changes.startTls
  • Default: false

<subject>

Subject for the email.
  • Type: java.lang.String
  • Required: Yes
  • User Property: changes.subject
  • Default: [ANNOUNCEMENT] - ${project.name} ${project.version} released

<templateEncoding>

The encoding used in the announcement template.
  • Type: java.lang.String
  • Since: 2.10
  • Required: No
  • User Property: changes.templateEncoding
  • Default: ${project.build.sourceEncoding}

<toAddresses>

Recipient email address.
  • Type: java.util.List<java.lang.Object>
  • Required: Yes

<username>

The username used to send the email.
  • Type: java.lang.String
  • Required: No
  • User Property: changes.username